writing-web-documentation

SKILL.md

Writing web documentation

Use this skill when the user wants excellent technical documentation for a web project, not merely "some text around the code." The job is to produce documentation that is easy to enter, easy to scan, easy to trust, and easy to maintain.

Good documentation is not a dump of product facts. It is a guided path through the product for a reader with a specific goal.

What this skill optimizes for

Fast first success
A new reader should reach a working result quickly.

Clear routing by intent
A beginner learning the product and an expert checking an option should not have to fight the same page.

Low ambiguity
Commands, file names, versions, prerequisites, expected outcomes, and failure states should be explicit.

Scannability
Busy developers skim before they read. Headings, intros, lists, tables, and code blocks should make the page navigable at a glance.