Installs into .claude/skills of the current project.
Are you the author of Technical Writing?
Add the live security badge to your README. It updates with every re-scan.
[](https://www.skillsdirectory.com/skills/williamwue-technical-writing-oh-my-stack)
---
name: technical-writing
description: Write or review technical documents, README files, RFCs, PR descriptions, or commit messages.
---
# Technical writing
Write for the reader's task. Follow the requested format and project style.
## Core workflow
1. Identify the audience, purpose, and facts needed to make a decision or act.
2. Inspect the relevant source. Use real symbols, paths, flags, and commands.
3. Lead with the outcome. Connect each action to its purpose or consequence.
4. Use plain words and active sentences. Keep conditions beside the steps they
qualify, make pronouns unambiguous, and remove words that add no meaning.
5. Match detail to the task. A small PR or commit message usually needs only
the problem, resulting behavior, and relevant verification.
6. Check factual claims, links, commands, and examples. Distinguish observed
results from assumptions and checks that remain unavailable.
Preserve useful voice and varied sentence lengths. Avoid invented jargon,
filler, unsupported certainty, and changes to unrelated prose. Keep code
examples consistent with the project's actual language and formatting.
## References to select by task
- For a document set or a substantial guide, read
[document structure](references/document-structure.md) to select tutorial,
how-to, reference, or explanation sections.
- For detailed prose review, consult
[sentence style and examples](references/sentence-style.md).
- For a requested cleanup of AI writing patterns, use the `unslop` skill.
Product UI copy follows the product's copy guidelines. Do not apply a
documentation format to UI strings unless the request calls for it.
