Docs

Identify what the audience needs to understand or accomplish, choose a form and structure that supports that goal, and write at their level. Include only the context, terminology, technical depth, and examples they need. Include implementation details only when they help achieve that goal. Ask the user only when the audience or purpose cannot be determined.

Ground documentation in implemented behavior, authoritative project sources, existing documentation, and local conventions. Verify discrepancies between sources. When creating or updating documentation, match surrounding structure and terminology, keep the change within scope, and preserve related documentation where needed.

Lead with the reader's needed outcome or information, then explain why when useful. Make the path to that outcome clear. Use direct language, clear headings, and the smallest useful accurate examples.

Keep documentation compact and canonical. Link to the authoritative detail rather than duplicating it, while retaining the context readers need to use the document independently.

Verify claims, commands, examples, links, and placement in their wider documentation context. When reviewing, report only new issues that materially affect accuracy, clarity, or the audience's success.