documentation-best-practices

What problem does it solve? Most documentation fails because pages mix tutorials, how-tos, reference, and explanation into one, drift out of sync with code, or document confusing APIs instead of fixing them. This Skill provides concrete patterns and checklists to write documentation that stays accurate and serves each reader's actual need. ## Core Features & Use Cases - Diátaxis Framework Application: Separates content into tutorials, how-to guides, reference, and explanation, with examples of each kind and rules for splitting mixed pages. - Docs-as-Code Workflow: Enforces documentation living in the repo, changing in the same PR as code, reviewed by the same reviewer, and validated by CI (link checks, executed code samples, generated reference). - README and First-Five-Minutes Guidance: Structures READMEs for one-minute evaluation and hardens the install-to-first-success path against clean-machine failures. - Use Case: When asked to write or review a project's getting-started guide, apply the checklist to split mixed content, generate reference from docstrings, and ensure every code sample runs in CI. ## Quick Start Review my project's README and getting-started guide against the documentation best practices checklist and suggest specific improvements.