Overview
The Docs standards: documentation rules and templates.
- Application Template - per-app overview (users, features, views) and architecture
- Docs Are Hierarchical, Explicit And Short - summary, contents with a fitting heading, a heading or page per item, name things outright
- Docs Describe Behavior, Not Wiring - describe behavior, not code wiring
- Docs Folder Structure - root overview and architecture. Development, workspace, features. Every record under one records folder
- Docs State Knowledge - knowledge pages state what is true, without provenance
- Documentation Philosophy - product-level, brief, one purpose per file, plain punctuation, reproducible from the docs
- Feature Spec Template - spec use cases with stable ids. Start state, action, confirms
- Feature Template - a feature doc: summary, contents, a heading per item, aesthetics, edge cases. Functional only, no UI copy, use cases live in the spec
- File Names - a file is named after its title, in lowercase, with dashes
- Glossary - the terms a project uses most, one entry each, described in plain words
- Library Feedback - library friction is surfaced to the director in the report, or filed with a library the project contributes to, never kept as a doc in the project. A workaround gets a why-comment
- No Faux Headers In Lists - no bold-label bullets. Promote them to headings
- UI Vocabulary - functional UI names: drawer, sheet, never 'surface'
- Workspace Levels - a maturity scale for a workspace, from unknown to suite complete
- Workspace Suite - the deliverables of a complete workspace
- Workspace Template - workspace docs: functional overview, technical architecture, concern docs