Skip to content

Documentation Standards

Every package must contain:

  • __init__.py with a module docstring summarizing purpose
  • README.md following the Purpose / Responsibility / Dependencies / Future Interfaces / Status / Testing template

Every architectural class must document:

  • Purpose
  • Responsibility
  • Dependencies (conceptual, even before implemented)
  • Future Interfaces

Docs are written in Markdown, one topic per file, cross-linked from docs/README.md.