Documentation Standards

How to write clear and useful documentation

Willayam Updated

File contents

Documentation Standards

README Requirements

Every project README should include:

  1. What - Brief description of what the project does
  2. Why - Problem it solves
  3. How - Quick start guide
  4. Setup - Installation and configuration
  5. Usage - Common use cases with examples

Code Comments

  • Document "why" not "what"
  • Keep comments up to date
  • Use JSDoc/docstrings for public APIs

API Documentation

  • Document all endpoints
  • Include request/response examples
  • Note authentication requirements
  • List error codes and meanings

Willayam/skillkeep/tree/main/fixtures/skills/documentation commit 1391830721

Frequently asked questions

npx skillmds@latest add willayam/documentation-standards