Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Q4 2024] [Contributor-Facing Documentation] Schema Updates + Clarity on how to engage with schema + examples #142

Open
aclayton555 opened this issue Sep 11, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@aclayton555
Copy link

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

@aclayton555
Copy link
Author

aclayton555 commented Oct 31, 2024

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 #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

@aclayton555 aclayton555 changed the title [Q4 2024] [Contributor-Facing Documentation] Clarity on how to engage with schema + examples [Q4 2024] [Contributor-Facing Documentation] Schema Updates + Clarity on how to engage with schema + examples Oct 31, 2024
@aclayton555 aclayton555 added the documentation Improvements or additions to documentation label Nov 1, 2024
@aclayton555
Copy link
Author

24-11/12 Blocked until tech writer contract in place.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant