Finalise MVP overview draft

[podpearson]

https://docs.google.com/document/d/1E-OWa4ig0LbVj7Y-wulXUvorKKbm2taB3dgyx_Xec58

[magnusmanske]

The document is now here

[podpearson]

@magnusmanske I have suggested some minor changes (typos and formatting) to the doc in pull request #23. Going forwards, please could we continue to use issues, branches and pull requests to update documents, as per https://github.com/malariagen/vector-ops/blob/master/README.md, in order to track changes to documentation? (see also #6)

In addition, I would recommend the following changes:

• [x] Assuming we are going to use issues, branches and pull requests to update documents, as per https://github.com/malariagen/vector-ops/blob/master/README.md, I don't think we need document version numbers, so these could be removed.

Use cases are listed both in "## Use cases" and in "## Appendix", but with slightly different entries. Progress is given against each use case in both places. I think some descriptions are now out of date, e.g. "The current version does not track Alfresco study codes". I would recommend the following changes, the main idea here being that this document should capture what needs to be done for the MVP, with details of what has being done being recorded in different issues:

• [x] Create a separate issue in fits repo for each use case so that we can track progress
• [x] If the use case is considered essential for MVP, then mark with "MVP V1" milestone
• [x] Have just a single list of use cases in "## Use cases" section, i.e. remove the appendix after checking everything from there is captured elsewhere
• [x] Remove any reference to current status of the use case from this document - progress should be tracked in individual issues for each use case
• [ ] Ensure there is a minimal description of each use case in this doc
• [ ] If you want to describe how a use case is met, do this in the relevant issue, rather than in this document
• [ ] Ensure all descriptions are up to date, e.g. regarding what else is in MVP
• [x] Make a link to the relevant issue for each use case

In "Other documents" section:

• [x] Ensure list matches list of documents already created or planned
• [x] Where documents already exist, provides links to the relevant documents
• [x] Create a github issue for "Command line utility description" then create first draft of this

In "Future plans" section:

• [x] Ensure there is a github issue corresponding to each item in this list
• [x] Add links to each github issue form this document
• [x] Change wording of "Command line tool" to describe what still needs to be done here (i.e. the query engine), rather that is already in place

Other:

• [ ] consider whether any other outstanding issues should be in scope for the MVP, and if so mark with "MVP V1" milestone, e.g. #19, #20, #21, #22 ?

[magnusmanske]

I don't think we need a description duplication for the issues.

[podpearson]

I don't think we need a description duplication for the issues.

Not sure what you mean here, could you expand?

[magnusmanske]

I mean "Ensure there is a minimal description of each use case in this doc". Especially if the use case is already solved.

Issues 19-22 are about data, not about the technology, and are thus not in scope for MVP V1 IMHO.

I would close this issue, unless there are things that need addressing.