Documentation Mandates
Documentation exists solely to provide high-level architectural insight and to clarify non-obvious protocols. Anything else is noise and must be deleted.
The Rules
Section titled “The Rules”- Zero Redundancy: Never document anything trivially understood by reading proto files, source code, or CLI help. Do not list flags, CRUD fields, or standard library usage.
- Focus on the Unintuitive: Document only what is unique to mzchat or likely to confuse a competent engineer.
- Protocols over Implementation: Document the design and the contracts between components. Do not mirror code. Documentation should remain valid even after internal refactors.
- Concise Overviews: Explain the “what” and the “so what.” Avoid implementation details that are in flux. If a feature lacks an unintuitive architectural pillar, it does not need a dev page.
- No Churn: Document only stable design pillars. Granular documentation that requires updates during routine refactoring is forbidden.