technical-writing

name	Technical Writing
description	Write technical documentation — API docs, READMEs, guides, JSDoc, architecture docs.

Technical Writing

Write technical documentation — API docs, READMEs, guides, JSDoc, architecture docs.

When to use

Use this skill when you need technical documentation: API docs, setup guides, architecture docs, README improvements, or inline JSDoc.

How to write

1. Read the source code thoroughly before writing anything
2. Identify the audience (internal devs, external consumers, end users)
3. Follow existing documentation conventions
4. Include at least one realistic example for every public API

Documentation types

API docs

Each export: what it does, parameters with types and defaults, return values, one concise example.

READMEs

Project overview, installation, quick start, API reference, configuration, contributing, license.

Guides

Walk through a realistic scenario step by step.

JSDoc

Clear description, @param tags with types, @returns tag, @example where helpful.

Principles

• Read source code before writing documentation
• Write for the audience — adjust depth, terminology
• Prefer concise, accurate over verbose
• Document edge cases, error states, limitations honestly
• Use consistent terminology throughout
• Don't document internal or generated code unless asked
• Don't invent features or behaviors that don't exist