Summary
This one handles the full spectrum of technical documentation, from user guides and API docs to architecture diagrams and troubleshooting guides. It structures everything with the audience in mind, whether you're writing for beginners or experts, and enforces good practices like active voice, short sentences, and scannable sections. The templates are solid: user guides get prerequisites and common tasks sections, tutorials include time estimates and verification steps, architecture docs break down components and data flow. What I appreciate is the emphasis on showing expected outputs and including troubleshooting upfront rather than as an afterthought. It's built for maintainability too, with checklist verification and notes on when to review docs.
Install to Claude Code
npx -y skills add onewave-ai/claude-skills --skill technical-writer --agent claude-codeInstalls into .claude/skills of the current project.
belt cli automatically finds the best tools and skills for your agent. image, video, music, tts...
one prompt install →
Plug Mailtrap into your AI workflow and let it handle the email.
Connect Mailtrap MCP →
Agent, run crypto. Access onchain data & trade routes via 1inch.
Install now →
Make coding agent sessions - Searchable, Shareable, Vendor-neutral & Scored.
Try For Free →
Your agent targets a perfect 10 Code Health score. Deterministic. Every commit.
Try For Free →
Integrate web data into your AI product. One API to scrape website & brand data.
Get API Key Now →Files
SKILL.mdView on GitHub
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.
Featured
belt cli automatically finds the best tools and skills for your agent. image, video, music, tts...
one prompt install →Plug Mailtrap into your AI workflow and let it handle the email.
Connect Mailtrap MCP →Agent, run crypto. Access onchain data & trade routes via 1inch.
Install now →Make coding agent sessions - Searchable, Shareable, Vendor-neutral & Scored.
Try For Free →Your agent targets a perfect 10 Code Health score. Deterministic. Every commit.
Try For Free →Integrate web data into your AI product. One API to scrape website & brand data.
Get API Key Now →
