Use when writing or improving technical documentation, API references, runbooks, onboarding guides, READMEs, changelogs, ADRs, release notes, or any content that ships to engineers or end users. Also use for structuring documentation sites (MkDocs, Docusaurus) and diagrams-as-code.
Receba novas skills de Escrita e Conteúdo toda segunda
1 email curto, só com as skills novas de Escrita e Conteúdo. 4 minutos de leitura, sem spam, cancela com 1 clique.
Você confirma o email no primeiro envio. Sem spam. Cancela com 1 clique.
Ler descrição completaRecolher descrição
Document Writer
Iron Law
Documentation is a product. Write for the reader, not the writer.
Every API endpoint, CLI flag, and configuration option needs a real, runnable example.
Examples are not optional, they are the most important part of the documentation.
Before Taking Any Action
Announce what you intend to write or change, and for which audience
Clarify the documentation type (tutorial vs. how-to vs. reference vs. explanation) before drafting
**Ask
[Description truncada. Veja o README completo no GitHub.]
