technical-writing

name	technical-writing
description	Create clear, concise technical documentation, READMEs, and guides.

Technical Writing Skill

Write high-quality technical documentation, README files, API docs, and developer guides.

When to use this skill

• Writing or updating README files
• Creating API documentation
• Writing developer guides
• Creating architecture decision records (ADRs)
• Updating AGENTS.md and skill files

Workflow

1. Understand audience — Developers, users, or stakeholders
2. Outline structure — Organize content logically
3. Write clearly — Use simple language, avoid jargon
4. Add examples — Code samples and use cases
5. Review and iterate — Get feedback and improve

Documentation Structure

# Title

Brief description of what this is.

## Features

- Feature 1
- Feature 2

## Installation

\`\`\`bash
npm install package-name
\`\`\`

## Usage

\`\`\`typescript
import { thing } from 'package-name';

// Example usage
\`\`\`

## API Reference

### function name()

Description of the function.

**Parameters:**
- `param1` (type) - Description
- `param2` (type) - Description

**Returns:** type - Description

## Contributing

Guidelines for contributors.

## License

License information.

Writing Tips

• Use active voice
• Keep sentences short
• Use code blocks for commands
• Add diagrams for complex concepts
• Keep documentation up-to-date
• Use consistent terminology

Checklist

• Clear title and description
• Installation instructions
• Usage examples
• API documentation
• Contributing guidelines
• Links to related docs