Skip to content

Functional overview for the pilot phase. WIP pre Kick off on 11th June 2020!

Notifications You must be signed in to change notification settings

stichtingsem/functional-overview

Repository files navigation

Functional Overview

This repository will be the home for all of the functional defintions and use cases that will be explored and validated as part of the pilot phase for the new 'Chain to Ecosystem' pilot during 2020.

The initial document that outlined the approach can still be found here:

SEM - Moving from a Chain to an Ecosystem

Rationale

This repository is split into the documents that provide a functional overview for how the ecosystem works, with definitions of the high level services, actors, data entities and use cases.

The initial intent is to guide the prototype / validation stage of the process, and keep the work streams aligned through the summer of 2020. This repository may evolve into the basis for the standards related to the services and APIs.

We are using Github to ensure that all work and discussions are held completely in the open, and that the source code for any example services or data exchanges are held and versioned alongside any of the functional documentation.

Scope of Pilot

The scope of the pilot in June 2020 is focusing on the use cases OA.3 and OA.4 (ordering and access), the other use cases will be explored in further phases.

Structure

Documents description
Services Description of the services that can be provided by any or all participants.
Roles Description of roles that exist to perform actions in and across the services.
Use Cases Description of high level processes, and then smaller steps within a process to allow for functional and technical design, testing and validation.
Entities Overview of data entities exchanged as part of the use cases.
Glossary Definition of key terms.

Functional track working documentation

Process for making changes

The working practices of this group will follow typical processes of technology standard groups and open source projects.

  • All documentation (where possible) will be in plain text files in a repository like this one. This makes it accessible for all and easy to version control and track changes over time.
  • To make changes, please take a local copy of the files, make the changes, and submit them back as a pull request. This ensures that discussion can occur in the open on any change before it is agreed, and we maintain a clear and transparent history once the process begins.
  • You can make small changes using the web editor, but you still need to submit your changes via a pull request.
  • Pull requests will be reviewed by an agreed group of reviewers for each stream (TBD).
  • If you would just like to start a discussion, please create an issue in this repository.

Working with Markdown & Github

If you are not familiar with either Markdown or Github, it is best you start with some quick reads:

Free Editors and Tools

About

Functional overview for the pilot phase. WIP pre Kick off on 11th June 2020!

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published