Section 28Governance and Roadmap
Documentation requirements
Defines the user, model, API, tutorial, limitation, benchmark, and migration documentation required with the product.
Section relationships
| ID | Name | Priority | Requirement | Verification |
|---|---|---|---|---|
| DOC-001 | Installation guide | MVP | Documentation SHALL cover installation and removal for every supported portable platform. | Demonstration |
| DOC-002 | Quickstart | MVP | A new user SHALL be able to run, inspect, modify, sweep, compare, export, input-re-execute, and play back the reference rover experiment by following one guide. | Demonstration |
| DOC-003 | Model semantics | MVP | Every built-in physics, environment, material, device, and sensor model SHALL document equations or algorithm, parameters, units, assumptions, limitations, and validity envelope. | Inspection |
| DOC-004 | Capability matrix | MVP | Documentation SHALL list supported, approximated, unsupported, backend-specific, and future capabilities. | Inspection |
| DOC-005 | Format coverage | MVP | Every importer and exporter SHALL document supported elements, versions, conversions, extensions, and known losses. | Inspection |
| DOC-006 | Determinism guide | MVP | Documentation SHALL distinguish input re-execution, checkpoint resume, and recorded-state playback and explain how settings, platform, parallelism, and adapters affect each guarantee. | Inspection |
| DOC-007 | Solver evidence-status report | MVP | Each released built-in solver profile SHALL link to current verification and evidence-status reports that include applicable validation references or an explicit unqualified status. | Inspection |
| DOC-008 | API reference | MVP | Public Rust APIs, CLI commands, schemas, diagnostics, metrics, and configuration fields SHALL have reference documentation. | Inspection |
| DOC-009 | Controller guide | MVP | Documentation SHALL include a complete native Rust controller example with timing, state, errors, and reproducibility behavior. | Demonstration |
| DOC-010 | ML evaluation guide | Beta | Documentation SHALL include domain randomization, batched evaluation, seeding, termination, and result interpretation. | Demonstration |
| DOC-011 | ROS 2 guide | External | Documentation SHALL include adapter installation, version compatibility, clock, QoS, frames, controllers, and limitations. | Demonstration |
| DOC-012 | Extension SDK guide | Beta | Documentation SHALL include one complete Wasm or process extension, conformance execution, packaging, permissions, and compatibility handling. | Demonstration |
| DOC-013 | Known limitations | MVP | Release documentation SHALL state known physical, numerical, platform, import, performance, and security limitations. | Inspection |
| DOC-014 | Glossary | MVP | Documentation SHALL define every canonical term used by project files, reports, UI, and public APIs. | Inspection |
Generated from the canonical specification. Edit section metadata or prose in docs/requirements.md; the website rebuilds this page and its relationships automatically.