Skip to main content

What Gets Documented

Not everything warrants the same documentation treatment. The following table maps content categories to their audience, format, and update triggers.

CategoryAudienceContent TypeUpdate Trigger
ArchitectureDevelopers, AI agentsData flow diagrams, component maps, service inventoriesNew service, new integration, structural refactoring
ADRsDecision-makers, future developersContext, decision, consequences, alternativesTechnology choice, pattern change, data model decision
API ReferenceIntegrators, frontend developersEndpoint documentation, request/response schemas, auth requirementsNew endpoint, schema change, behavior change
Strategy & BusinessPartners, investors, regulatorsBusiness context, market analysis, regulatory positioningFunding rounds, partnership changes, regulatory developments
ComplianceRegulators, auditors, legalEU AI Act mapping, GDPR processing records, AML methodologyNew AI feature, new data processing activity, regulatory update
FeaturesProspects, demo audiencesFeature showcases, capability descriptions, competitive positioningNew feature launch, significant enhancement
Project stateFresh AI agents, returning developersSTATE.md — current milestone, last shipped, blockers, next-upPer-shipped-artifact (task lands, ADR accepted, milestone closes); see Section 11.6

The table is deliberately conservative. Not every code change triggers a documentation update. Configuration changes, bug fixes, and minor refactoring do not need documentation. The triggers are structural changes that alter how the system works, not tactical changes that fix how it behaves.