Skip to main content

Documentation As Code

Documentation is part of the implementation contract.

Minimum Standard​

  • every new or modified TypeScript source file gets a file-level @moduledoc
  • every exported/public contract gets a @doc
  • complex internal logic gets rationale comments when intent is not obvious
  • final documentation comments are written through direct file edits

Quality Bar​

  • no filler comments
  • no syntax narration
  • no invented behavior
  • keep docs aligned with actual code