Skip to content
SENS Platform Docs

Documentation Guidelines

Documentation is part of the source of truth.

Rules:

  • Changes to contracts, configuration, deployment, operations, security, tenancy, persistence, or user workflows must update documentation in the same change.
  • Public API behavior must be reflected in OpenAPI and user-facing API guides.
  • Cross-module contracts must have an authoritative location.
  • Technical decisions should be captured in ADRs.
  • User-facing pages should explain outcomes and workflows, not internal code structure.
  • Internal technical pages should include enough detail for future developers and AI-assisted support workflows to reason safely.