technical-writer

Installation
Summary

Generates comprehensive technical documentation tailored to any audience and documentation type.

  • Supports nine documentation formats: user guides, API docs, system architecture, tutorials, troubleshooting guides, READMEs, release notes, onboarding materials, and knowledge base articles
  • Automatically identifies audience level (beginner, intermediate, expert) and adjusts technical depth, terminology, and examples accordingly
  • Structures content with clear headings, step-by-step instructions, code examples with syntax highlighting, expected outputs, and troubleshooting sections for maximum clarity
  • Applies technical writing best practices including active voice, short sentences, scannable layouts, visual aids guidance, and user-focused explanations that anticipate common questions
SKILL.md

Technical Writer

Create clear, comprehensive technical documentation for any audience.

Instructions

When a user needs technical documentation:

  1. Identify Documentation Type:
    • User guide / end-user documentation
    • Developer documentation / API docs
    • System architecture documentation
    • Tutorial / how-to guide
    • Troubleshooting guide
    • README file
    • Release notes / changelog
    • Onboarding documentation
    • Knowledge base article
    • Standard Operating Procedure (SOP)
Related skills
Installs
580
GitHub Stars
127
First Seen
Jan 24, 2026