-
Notifications
You must be signed in to change notification settings - Fork 32
Documentation
Amy Coffin edited this page Nov 26, 2018
·
40 revisions
Developers:
- Tag Amy on a Pull Request with any new documentation so that she can check changes and approve them using the GitHub UI
- Either Docs branch of feature or just one file in the feature Pull Request
- Any new documentation can be visualized either on the developer’s feature branch or on the dev sandbox
- Amy can also run the site locally on her own machine as she edits/updates changes to ensure more streamlined editing
- Documentation needs to be started as early as possible, especially if it requires EGG commentary. Thus, Amy should be notified of documentation needs at the earliest stage in the development process as possible, and will communicate what she needs in order to begin drafting (sandbox, feature-specific conversation with Melissa and developers, etc.)
- Ideally, there is a 2 week review period for all EGG commentary on Google Docs, and they can be rendered into markdown 2-4 days prior to the beta release. Beta should have minimal and superficial commentary from EGG, though they can veto docs that do not meet standards during the beta period.
This table tracks the documentation drafts, circulation dates, and intended releases for each piece of documentation being developed. INT = Date Circulated for Internal review; FG = Date Circulated to Genetic Counselor Focus Group; EGG = Date Circulated to EGG
Please address any feedback to any material in the google doc itself as a comment.
Italicized Text indicates projected Timelines. Actual timelines non-italicized.
| Date | What was prototyped | Release | INT | FG | EGG | Links |
|---|---|---|---|---|---|---|
| 11/26/18 | Consolidation of Help/FAQ | December | 11/5 | N/A | 11/7 | Wireframes |
| 10/7/18 | Expert Reviewed "Sprucing" | October | 10/12 | NA | 10/16 | Help/ Classifications Google Doc |
| 7/20/18 | Nontechnical In Silico Probabilities Help Text | August | 5/14, 6/15 | NA | 8/20-9/20 | GoogleDoc |
| 4/3/18 | Reorganized/Updated APD Help | (Late) April | N/A | N/A | 4/3 | GoogleDoc, Specifications |
| 4/3/18 | Transcript Visualization Help Text | (Late) April | 3/27 | N/A | 4/3 | GoogleDoc |
| 4/10/18 | ClinVar Tile Help Text | X | 4/11 | X | X | GoogleDoc |
| 4/10/18 | Allele Frequency Help Text | May | 4/11 | N/A | 5/22 | GoogleDoc, Gitbook |
| 5/20/18 | CRAVAT / MuPIT Help Text | May | 5/2 | N/A | 5/22 | GoogleDoc, Gitbook |