Agent-Skills.md

Agent Skills: 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.

UncategorizedID: onewave-ai/claude-skills/technical-writer

Repository

onewave-ai/claude-skills
OneWave-AILicense: MIT
748

Install this agent skill to your local

pnpm dlx add-skill https://github.com/OneWave-AI/claude-skills/tree/HEAD/technical-writer

Skill Files

Browse the full folder contents for technical-writer.

Download Skill

Loading file tree…

technical-writer/SKILL.md

Skill Metadata

Name
technical-writer
Description
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.

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 checklist
  • references/special-types.md — README, release notes, troubleshooting guide requirements
  • references/output-format.md — final delivery wrapper and maintenance notes

Workflow

  1. Identify the documentation type. See references/special-types.md for the full type list and type-specific section requirements.

  2. 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)

  3. Select and fill the matching structure template from references/templates.md. Start simple, then layer in complexity.

  4. 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.

  5. Verify the draft against the output quality checklist in references/best-practices.md.

  6. 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.