technical-writer
Write comprehensive technical documentation including user guides, how-to articles, system architecture docs, onboarding materials, and knowledge base articles. Creates clear, structured documentation for technical and non-technical audiences. Use when users need technical writing, documentation, tutorials, or knowledge base content.
How do I install this agent skill?
npx skills add https://github.com/onewave-ai/claude-skills --skill technical-writerIs this agent skill safe to install?
- Gen Agent Trust Hubpass
This skill is a pure instruction-based prompt designed for technical writing. It contains no executable code, scripts, external dependencies, or network operations, making it inherently safe to use.
- Socketpass
No alerts
- Snykpass
Risk: LOW · No issues
- Runlayerwarn
1/1 file flagged
- ZeroLeakspass
Score: 93/100 · 2 sections analyzed
What does this agent skill do?
Technical Writer
Create clear, comprehensive technical documentation for any audience.
Contents
references/templates.md— structure templates (user guide, tutorial, architecture)references/best-practices.md— clarity, structure, visuals, code, and quality checklistreferences/special-types.md— README, release notes, troubleshooting guide requirementsreferences/output-format.md— final delivery wrapper and maintenance notes
Workflow
-
Identify the documentation type. See
references/special-types.mdfor the full type list and type-specific section requirements. -
Determine the audience:
- Technical level (beginner, intermediate, expert)
- Role (end user, developer, admin, stakeholder)
- Prior knowledge assumptions
- Context (internal team, external customers, open source community)
-
Select and fill the matching structure template from
references/templates.md. Start simple, then layer in complexity. -
Apply technical writing best practices from
references/best-practices.md: short sentences, active voice, specific instructions, scannable structure, runnable code examples, and a user-focused angle. -
Verify the draft against the output quality checklist in
references/best-practices.md. -
Deliver using the wrapper in
references/output-format.md, including the documentation checklist and maintenance notes.
Example Triggers
- "Write user documentation for my feature"
- "Create a tutorial for setting up the development environment"
- "Document this system architecture"
- "Write a troubleshooting guide"
- "Create onboarding documentation for new developers"
- "Write a README for this project"
Generate professional, comprehensive technical documentation that enables users to succeed.
How can the creator link this skill?
Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.
<a href="https://skillzs.dev/skills/onewave-ai/claude-skills/technical-writer">View technical-writer on skillZs</a>