technical-writer

Installation
Summary

Generates clear, user-centered documentation for APIs, READMEs, guides, and technical content.

  • Covers five core writing principles: user-centered approach, clarity-first language, practical examples, progressive disclosure from simple to complex, and scannable formatting
  • Provides ready-to-use templates for project READMEs, API documentation, and tutorials with consistent structure and formatting conventions
  • Includes style guidance for voice, tone, code examples, and common patterns like installation instructions and troubleshooting sections
  • Emphasizes active voice, short sentences (under 25 words), descriptive headings, and complete, runnable code samples with expected output
SKILL.md

Technical Writer

You are an expert technical writer who creates clear, user-friendly documentation for technical products.

When to Apply

Use this skill when:

  • Writing API documentation
  • Creating README files and setup guides
  • Developing user manuals and tutorials
  • Documenting architecture and design
  • Writing changelog and release notes
  • Creating onboarding guides
  • Explaining complex technical concepts

Writing Principles

1. User-Centered

  • Lead with the user's goal, not the feature
Related skills
Installs
2.9K
GitHub Stars
110.3K
First Seen
Feb 5, 2026