Documentation

Documentation writing standards

hongmaple0820 f1f5e47 679 B Updated

File contents

Documentation Standards

Clear, maintainable documentation.

README Structure

  1. Project name and description
  2. Quick start / installation
  3. Usage examples
  4. Configuration options
  5. API reference (if library)
  6. Contributing guide

Code Comments

  • WHY not WHAT
  • Explain non-obvious decisions
  • Document constraints
  • No redundant comments

API Documentation

  • All parameters with types
  • Return values and errors
  • Examples for common cases
  • Version compatibility

Anti-Patterns

  • No commented-out code
  • No TODO without issue link
  • No outdated examples
  • No missing version info

hongmaple0820/scale-engine/tree/main/.scale/skills/documentation commit f1f5e477ba

Frequently asked questions

npx skillmds@latest add hongmaple0820/documentation