technical-writing
Write, edit, or audit docs pages (tutorials, how-tos, concepts, reference, troubleshooting, rule pages) in the site's conventions and one stylebook, then test them. Do NOT use for endpoint API guides (use api-doc-authoring) or claim checks (use doc-accuracy).
- License
- MIT
Pinned to revision 57feafaed3c9, so it is the text this page describes rather than whatever the author pushed since.
Files
- skills/technical-writing/SKILL.md
- skills/technical-writing/references/common-documentation-issues.md
- skills/technical-writing/references/content-types.md
- skills/technical-writing/references/cross-referencing.md
- skills/technical-writing/references/prose-patterns.md
- skills/technical-writing/references/provenance.md
- skills/technical-writing/references/site-profiles/aspire-dev/integration-documentation.md
- skills/technical-writing/references/site-profiles/aspire-dev/site-conventions.md
- skills/technical-writing/references/site-profiles/aspire-dev/site-specific-rules.md
- skills/technical-writing/references/site-profiles/aspire-dev/terminal-recordings.md
- skills/technical-writing/references/stylebook-selection.md
- skills/technical-writing/references/stylebooks/18f-content.md
- skills/technical-writing/references/stylebooks/apple-interface-writing.md
- skills/technical-writing/references/stylebooks/cdc-clear-communication.md
- skills/technical-writing/references/stylebooks/github-docs.md
- skills/technical-writing/references/stylebooks/gitlab-docs.md
- skills/technical-writing/references/stylebooks/google-developer-docs.md
- skills/technical-writing/references/stylebooks/govuk.md
- skills/technical-writing/references/stylebooks/kubernetes-docs.md
- skills/technical-writing/references/stylebooks/mailchimp-content.md
- skills/technical-writing/references/stylebooks/mdn-web-docs.md
- skills/technical-writing/references/stylebooks/microsoft-writing-style.md
- skills/technical-writing/references/stylebooks/nasa-technical-writing.md
- skills/technical-writing/references/stylebooks/nhs-health-content.md
- skills/technical-writing/references/stylebooks/red-hat-docs.md
- skills/technical-writing/references/stylebooks/sec-plain-english.md
- skills/technical-writing/references/stylebooks/w3c-technical-reports.md
- skills/technical-writing/references/testing-your-documentation.md
- skills/technical-writing/references/writing-process.md
Every link opens the file at its source, pinned to the revision this page describes.