Docs
Document the behavior, decision, or operation a reader needs, at the location that owns its meaning. Keep prose, commands, examples, and comments truthful as the system changes.
- Name the reader and the question the document must answer.
- Find the closest source of truth and the nearest durable location.
- Write the smallest explanation that makes the path usable.
- Run commands and inspect examples against the current system.
Read the detailed guide when choosing document structure, updating a project-wide guide, or reviewing stale documentation.