Documentation Principles

These principles keep docs accurate, minimal, and maintainable.

Principles

• Docs describe what exists - Document only current main state.
• One document, one purpose - One audience and one question per file.
• Scale by folders - Promote long docs to folders.
• Link to code properly - Use permalinks for non-doc files.
• Format and consistency - Avoid low-signal formatting.
• Structure uniformity - Keep naming and layout consistent.

Scope

• Applies to all files in docs/.
• Rare exceptions must be explicit and explained in the document.

See Also

• Content Mapping Registry - Where to document code changes
• Authoring Documentation - Practical writing guidance
• Developer Setup - Working in the repo