Technical Writer Skill for Claude
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.
Install
one command, takes just this skill from the repositorynpx skills add https://github.com/OneWave-AI/claude-skills --skill technical-writerThe instruction itself
4 sections, as written by the authorTechnical 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.
Other skills for the same job
different authors, same section of the catalogue
Convert Markdown files to HTML similar to `marked.js`, `pandoc`, `gomarkdown/markdown`, or similar tools; or writing custom script to convert markdown to html and/or working on web template systems like `jekyll/jekyll`, `gohugoio/hugo`, or similar web templating systems that utilize markdown documents, converting them to html. Use when asked to "convert markdown to html", "transform md to html", "render markdown", "generate html from markdown", or when working with .md files and/or web a templating system that converts markdown to HTML output. Supports CLI and Node.js workflows with GFM, CommonMark, and standard Markdown flavors.
Write and maintain technical documentation. Trigger with "write docs for", "document this", "create a README", "write a runbook", "onboarding guide", or when the user needs help with any form of technical writing — API docs, architecture docs, or operational runbooks.
Translate visa application documents (images) to English and create a bilingual PDF with original and translation
Write, review, and edit documentation files with consistent structure, tone, and technical accuracy. Use when creating docs, reviewing markdown files, writing READMEs, updating `/docs` directories, or when user says "write documentation", "review this doc", "improve this README", "create a guide", or "edit markdown". Do NOT use for code comments, inline JSDoc, or API reference generation.
Real-time Constitution compliance checker for devflow documents. Blocks partial implementations and hardcoded secrets during file editing.
Write self-documenting code with minimal, evergreen comments that explain complex logic without describing recent changes or temporary fixes. Use this skill when writing code comments, documentation strings, explaining complex algorithms, clarifying business logic, or deciding whether code needs comments. Apply when working with any source code files where comments or documentation might be added, ensuring comments remain relevant, helpful, and focused on explaining why rather than what the code does, while preferring clear code structure and naming over excessive commenting.
Use when writing technical documentation that needs to be readable by both humans and AI models, converting existing docs to HADS format, validating a HADS document, or optimizing documentation for token-efficient AI consumption.
Draft a structured investment committee memo for PE deal approval. Synthesizes due diligence findings, financial analysis, and deal terms into a professional IC-ready document. Use when preparing for investment committee, writing up a deal, or creating a formal recommendation. Triggers on "write IC memo", "investment committee memo", "deal write-up", "prepare IC materials", or "recommendation memo".
How to use it
Take onewave-ai/technical-writer from the repository into ~/.claude/skills for personal
use, or into .claude/skills inside a project.
The agent identifies a skill by the name field in its header. Two skills with the
same name cannot sit side by side — one of them will be ignored.