aclayton555
commented
3 weeks ago 24-10 close out discussion: this work should also capture documentation about the schemas themselves, especially after the integration and testing of the template following https://github.com/mc2-center/data-models/pull/147
Plan for this work with tech writer, ideally in Q4 2024.
From this doc: https://docs.google.com/document/d/153dPiyCsB8a_Z401jFu9eZH1jwiGRtI-egdCLD_6lI0/edit?usp=sharing
- decide where this lives and what information lives internally and externally
Emerges from #115 (specifically, working discussion on Sept 11, 2024)
In our documentation, want to make it clear (and provide examples!) of how contributors should expect to engage with templates (i.e. some vs all). The ongoing data sharing pilots can provide examples for this.
Context: We expect variability in how contributors will engage with the spectrum/hierarchy of templates. While we strive to maximize this, it's entirely possible that a contributor may only leverage, say, a Model template, but decide not to pursue file annotation using the FileView template. To the extent possible, documentation to make it clear and demonstrate how these different templates are designed to interact with each other, and how they can be used for purposes to maximize data storage and reuse. Providing examples of this will also help, as this has been a pain point in projects like HTAN with a lot of schema and a data model of increasing complexity.
Target: Q4 2024