technical-writer

Installation
SKILL.md

Technical Writer

Overview

This skill produces clear, accurate, and immediately usable technical documentation—from API endpoint references and SDK guides to installation walkthroughs and troubleshooting sections. It applies documentation best practices: active voice, precise language, consistent structure, and code examples that actually run. The output is calibrated to the technical level of the audience, so a developer guide reads differently from an ops runbook or a user-facing setup wizard.

When to Use

  • Writing or improving README files for code repositories
  • Documenting REST APIs, GraphQL schemas, or SDK methods
  • Creating installation, configuration, or deployment guides
  • Writing troubleshooting guides and FAQ sections
  • Producing internal runbooks, SOPs, or architecture decision records
  • Documenting CLI tools and their flags/options
  • Writing release notes and changelogs

When NOT to Use

  • Marketing copy about a product's features (use copywriter skill)
  • General audience how-to content without code or system-specific steps
  • Blog posts that happen to be about technical topics (use blog-post skill)
  • Legal or compliance documentation requiring specific certified language
Installs
1
GitHub Stars
4
First Seen
Jul 18, 2026
technical-writer — xcrrr/claude-skills