technical-writing
Use when writing, editing, or reviewing technical artifacts — READMEs, CONTRIBUTING and setup guides, knowledge-base pages, runbooks, migration and upgrade guides, API reference prose, architecture and design documents, release notes, long-form docstrings, pull request descriptions, or issue and ticket descriptions — including making text clearer for non-native English readers. Do not use to review README or documentation files the user changed in this checkout; engineering:review-changes owns that review and applies this skill inside. Do not use to assess, triage, or decide changes from unresolved review feedback. Once another workflow settles the feedback, use for drafting or rewriting technical comments in issue trackers, pull or merge request comments, and reviewer replies. Do not use for decision records (engineering:decision-records); for agent-instruction files such as AGENTS.md or SKILL.md; for chat responses, commit messages, or code comments; or for conceptual questions about writing standards.
- License
- MIT
Pinned to revision c32869429e9f, so it is the text this page describes rather than whatever the author pushed since.
Files
- skills/technical-writing/SKILL.md
- skills/technical-writing/agents/openai.yaml
- skills/technical-writing/evals/triggers.yaml
- skills/technical-writing/references/change-descriptions.md
- skills/technical-writing/references/collaborative-comments.md
- skills/technical-writing/references/controlled-language.md
- skills/technical-writing/references/document-modes.md
- skills/technical-writing/references/formatting.md
- skills/technical-writing/references/knowledge-bases.md
- skills/technical-writing/references/readme.md
Every link opens the file at its source, pinned to the revision this page describes.