Documentation Roadmap
This roadmap preserves the strategy order from the MolTrace documentation dashboard: write the user journey first, then module tutorials, then API reference, with legal and compliance live before paid onboarding.
Non-negotiable sequence
Section titled “Non-negotiable sequence”- Platform Overview
- Quick Start
- Core Concepts
- First module guide
- API reference
- Company, solutions, and resources
Legal and compliance pages run in parallel and must be live before paying customers onboard.
Ownership model
Section titled “Ownership model”Every page has exactly one owner for the first draft. Editors review for accuracy. A technical writer performs the final consistency pass. Any numbered step requires a screenshot or code block before the page ships.
Documentation dashboard
Section titled “Documentation dashboard”| Section | Page | Owner | Priority | Status |
|---|---|---|---|---|
| Foundation | Platform Overview | Product Lead | P0 Critical | In Progress |
| Foundation | Quick Start | Technical Writer | P0 Critical | In Progress |
| Foundation | Core Concepts | Technical Writer | P0 Critical | In Progress |
| Core Modules | SpectraCheck Overview | NMR Scientist | P1 High | To Do |
| Core Modules | NMR Interpretation Guide | NMR Scientist | P1 High | To Do |
| Core Modules | LC-MS/MS Annotation | MS Scientist | P1 High | To Do |
| Core Modules | qNMR Quantification | NMR Scientist | P2 Medium | To Do |
| Core Modules | Regulatory Hub Overview | Regulatory Scientist | P1 High | To Do |
| Core Modules | ICH Guidelines Reference | Regulatory Scientist | P1 High | To Do |
| Core Modules | Report Generation | Technical Writer | P1 High | To Do |
| Core Modules | Reaction Optimization Overview | Process Chemist | P2 Medium | To Do |
| Core Modules | Setting Up an Optimization | Technical Writer | P2 Medium | To Do |
| Core Modules | Interpreting Optimization Results | Process Chemist | P2 Medium | To Do |
| API | API Introduction | Backend Engineer | P1 High | To Do |
| API | Endpoint Reference | Backend Engineer | P1 High | To Do |
| API | Webhooks | Backend Engineer | P2 Medium | To Do |
| API | Python SDK | Developer Advocate | P2 Medium | To Do |
| Integrations | LIMS Integration | Developer Advocate | P2 Medium | To Do |
| Integrations | Bruker Integration | NMR Scientist | P2 Medium | To Do |
| Integrations | Agilent Integration | NMR Scientist | P2 Medium | To Do |
| Company | About | Founder / Marketing | P2 Medium | To Do |
| Company | Careers | HR / Founder | P3 Low | To Do |
| Company | Contact | Marketing | P1 High | To Do |
| Solutions | Pharmaceutical R&D | Marketing + Scientist | P1 High | To Do |
| Solutions | CRO / Analytical Labs | Marketing + Scientist | P2 Medium | To Do |
| Solutions | Enterprise | Marketing + Sales | P1 High | To Do |
| Resources | Case Study 1 — Pharma | Marketing + Customer | P1 High | To Do |
| Resources | Case Study 2 — Process Chemistry | Marketing + Customer | P2 Medium | To Do |
| Resources | Webinar 1 — Getting Started | Developer Advocate | P2 Medium | To Do |
| Resources | Webinar 2 — Regulatory Deep Dive | Regulatory Scientist | P2 Medium | To Do |
| Resources | Blog — Launch Post | Founder / Marketing | P2 Medium | To Do |
| Resources | Analytics Setup | Growth / Product | P1 High | In Progress |
| Legal & Compliance | Privacy Policy | Legal Counsel | P0 Critical | In Progress |
| Legal & Compliance | Terms of Service | Legal Counsel | P0 Critical | In Progress |
| Legal & Compliance | Security Policy | CISO / Technical Lead | P0 Critical | In Progress |
| Legal & Compliance | Compliance | Regulatory / Technical Lead | P0 Critical | In Progress |
Writing principles
Section titled “Writing principles”- Write for the user’s task, not the product feature.
- Keep one concept per page.
- Include a screenshot for every numbered step.
- Use scientific precision without unnecessary implementation jargon.
- Lead with the outcome.
- Keep legal language human-readable.
Recurring maintenance
Section titled “Recurring maintenance”Scan frontend routes, design baseline reports, backend API changes, and new module surfaces before each docs release. When a new user-facing surface ships, add the route to the visual baseline list, update the relevant docs page, and update the OpenAPI schema or backend contract if the surface depends on new endpoints.