Documentation

Good documentation is a force multiplier—it accelerates onboarding, reduces communication overhead, and ensures that knowledge persists beyond the tenure of any single engineer. The following standards define the documentation required for all services and infrastructure managed by the Open Home Foundation.

Area	Requirement	Why
General Documentation	Google Docs	Centralised, non-technical documentation accessible to all stakeholders. Provides high-level context, goals, and decisions.
Developer Documentation	README.md	Entry point for developers. Explains setup, architecture, workflows, and contribution guidelines.
API Documentation	Swagger Spec & UI	Built automatically by NestJS Swagger. Ensures API docs are always up to date without manual maintenance.
Architecture Documentation	DaC LikeC4 Diagrams	Like4C enables Diagrams as Code. Helps developers and stakeholders understand modules, data flows, boundaries, and responsibilities.
Infrastructure Documentation	IaC repo docs or deployment/CI-CD runbooks	Ensures any engineer can understand and reproduce the infrastructure, troubleshoot deployments, and maintain reliability.