Skip to content

Latest commit

 

History

History
24 lines (17 loc) · 979 Bytes

File metadata and controls

24 lines (17 loc) · 979 Bytes

AGENTS.md - Instructions for Coding Agents

Before Writing Documentation

Read these files in order:

  1. DIATAXIS.md - Determine the page type (tutorial, how-to, reference, explanation)
  2. CLAUDE.md - Follow the style guide (lead with code, no em dashes, tables over prose, etc.)

Workflow

  1. Identify the page type using the compass in DIATAXIS.md
  2. Follow the rules for that type
  3. Apply CLAUDE.md style rules
  4. Use the matching page template from CLAUDE.md

Common Mistakes

  • Writing a how-to guide that teaches basics (that's a tutorial)
  • Adding explanation paragraphs inside reference docs (extract to a "What is X?" page)
  • Making tutorials that offer choices ("you could also use..."). Tutorials follow one path.
  • Including full parameter tables in how-to guides (link to reference instead)
  • Using contrastive negation ("It's not X, it's Y"). State what it is directly.
  • Using em dashes. Use periods or rewrite.