Software Development

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.

Publisher / source
wondelai/skills (found on skills.sh, an awesome list, the CSV list)
Upstream record
wondelai/skills
Version
Version 2
Published
Publication review
Approved for publication
Content fingerprint
3037479dd6cffaf043f27cd6b6eaec3cb5fb209210241f73757d15790271b1f2