Documentation
A catalog of available documentation and resources to support learning
To support a systematic approach to our technical documentation, we have adopted the Diátaxis framework which identifies four distinct forms of documentation: tutorials, how-to guides, technical reference, and explanation. We aim for our documentation to be accessible to a broad audience so that — whether you’re new to microbiome research or a leading scientist in the field — you find it easy to explore as you learn about the various aspects of our development and engagement processes. We are also working to translate our written materials into different languages to make them more accessible to all users. We currently have available Spanish and French translations for NMDC EDGE training materials and a Spanish-translated presentation from former NMDC Ambassador Josué Rodríguez-Ramos.
Dive into the NMDC’s technical documentation to learn more.
Learn more about standards, best practices, and workflows
Tutorial
A learning-oriented approach that includes short, hands-on activities. Learn more about how to: Submit to the NMDC, Run multi-omics workflows, or Navigate the Data Portal.
How-To
A task-oriented approach that provides step-by-step instructions for using NMDC’s products and resources. Also learn best practices in data management.
Explanation
An understanding-oriented approach that includes background information covering a wide range of topics. Learn more about FAIR data and the NMDC’s Action Plan for Inclusion, Diversity, Equity, and Accountability.
Reference
An information-oriented approach that provides in-depth learning materials about metadata and standards, bioinformatics workflows, and the Data Portal.
