technical-documentation
Audit, write, and improve developer documentation using Google's Developer Documentation Style Guide and Technical Writing courses. Use this skill for any documentation work, even when the user names no style guide: "audit our docs", "review this README", "write a README", "getting started guide", "how-to or tutorial", "API reference", "docstrings", "CLI help text", "changelog or release notes", "migration guide", or "our docs are confusing". Also use it when writing docs from code, rewriting a doc for clarity, fixing headings, procedures, or code samples, or enforcing consistent voice and terminology across a docs set — prefer it over editing documentation unaided. Covers reader and doc-type fit, second person and active voice, procedures, headings, lists and tables, code samples and placeholders, link text, notices, the word list, timeless docs, and accessibility. For code comments and naming, see clean-code. For marketing or landing-page copy, see storybrand-messaging.
- Version
- 1.0.0
- License
- MIT
Pinned to revision c172996495be, so it is the text this page describes rather than whatever the author pushed since.
Files
- skills/technical-documentation/SKILL.md
- skills/technical-documentation/references/api-reference.md
- skills/technical-documentation/references/audit-checklist.md
- skills/technical-documentation/references/document-types.md
- skills/technical-documentation/references/procedures-and-code.md
- skills/technical-documentation/references/release-notes.md
- skills/technical-documentation/references/structure-and-formatting.md
- skills/technical-documentation/references/voice-and-words.md
Every link opens the file at its source, pinned to the revision this page describes.