Document Use Cases

[GeorgLink]

Sean emailed:

I was thinking principally of the high level use cases around Corporate to OSS; OSS to Corporate and Plain old OSS that we discussed as a group.

These might be elaborate; or have a number of dependent use cases or extensions in my ways. I think the audience is all of us; definitely my software engineering students ;) and probably anyone we bring into the project over time. Kind of as on boarding materials.

It gets more to the motivations that people have for using the system; which then drives us down to the specific metrics.

I also asked Derek to separate the front end for now into two sections: Statistics (raw measures) and “Synthetic Indicators”, which are an agglomeration of the raw measures.

This will also help us make decisions about which building blocks (statistics) need to be developed to support synthetic indicators, which are what is being flushed out in the working group.

Here’s an example from OCDX that I rather like: https://github.com/OCDX/OCDX-Engine/blob/master/use-cases/RS_Browse-Manifest.md

[GeorgLink]

I think it makes sense, I'll start documenting our use cases and we can refine them later.

Should I put the use cases in OSSHealth/ResearchProject since we will have multiple repositories for different parts of our architecture.

[sgoggins]

Georg: I would say if you could get thumbnails of the 3 main use cases we have discussed, oh, I don't know, "today", that would be awesome. That pattern is straightforward enough. I could do the diagrams. https://github.com/OCDX/OCDX-Engine/blob/master/use-cases/RS_Browse-Manifest.md

[GeorgLink]

@sgoggins I'd be happy to help.
Could I ask you for feedback on the first draft: #24
Based on your feedback, I can improve the use cases today.

[GeorgLink]

@sgoggins
I expanded the use cases: https://github.com/OSSHealth/ResearchProject/tree/usecases/UseCases
Feel free to accept the pull request #26 once you are satisfied with the use cases.