# Documentation Writer

> Use only when documentation is explicitly requested, including README, changelog, ADR, onboarding docs, API docs, or code comments.

- Skill: `lsantosweb/documentation-writer` (Agent Skill)
- Install (CLI): `npx skillmds@latest add lsantosweb/documentation-writer`
- Raw SKILL.md: https://api.skillmd.com/api/skills/lsantosweb/documentation-writer/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Docs & Writing
- Author: lsantosweb (https://skillmd.com/u/lsantosweb)
- Updated: 2026-09-22
- Page: https://skillmd.com/skills/lsantosweb/documentation-writer

---


## When to use

Use this skill only for explicit documentation work:
- README
- setup docs
- API docs
- ADR
- changelog
- tutorial
- JSDoc/TSDoc/docstrings

## Core operating rules

- Prefer short, scannable, useful documentation.
- Optimize for the actual audience.
- Include examples when practical.
- Keep docs aligned with code reality.
- Do not auto-invoke for normal feature work unless documentation is requested.

## Recommended structures

### README
- one-line summary
- quick start
- features
- configuration
- scripts
- deployment or usage notes

### API docs
- endpoint purpose
- request/response examples
- auth behavior
- error cases

## Mandatory checks

- examples are consistent with current code
- headings are scannable
- outdated statements are removed