SOP-DEV-documentation-completion-v1.0¶

1. Purpose¶

Define what "documentation complete" means as a mandatory close gate for development work. Code that works but isn't documented leaves the system brittle — the next agent, session, or engineer can't understand, use, or maintain it. Documentation completion is a quality criterion, not an afterthought.

Documentation completion signoff is required before: - A task can be marked Done in Monday.com - A feature can pass Release Readiness gate (SOP-DEV-release-readiness-v1.0) - An agent's capabilities can be claimed as updated in its contract

2. Documentation Requirements by Change Type¶

Change Type	Required Documentation
New agent capability	Agent contract update (`/Claude/system/agents/{dept}/{agent.id}.md`) with new capability in Inputs, Outputs, or Decision Rights
New SOP or SOP amendment	sop.manager authors/updates SOP; INDEX.md updated; change log entry filed
Workflow change	Affected SOP updated or new SOP authored; chief.staff and affected agents notified per SOP-OPS-protocol-amendment-propagation-v1.0
New external integration	Integration guide at `knowledge/tools/` or `knowledge/platforms/`; security.ops security review logged
New public endpoint or API surface	API reference or integration guide published to MkDocs per SOP-DEV-mkdocs-publication-v1.0
Architecture change	Decision Record (DR) at `knowledge/decisions/DR-{YYYY}-{NN}-{slug}.md` per SOP-MKT-knowledge-curation-cadence-v1.0 Section 5
Bug fix	If the bug reveals a systemic gap: SOP Delta per CLAUDE.md Section 6E
Tool or platform guide	New or updated article at `knowledge/tools/` or `knowledge/platforms/`; indexed in MkDocs nav

Changes that touch none of the above (pure internal refactor, style change, test improvement) require only the standard Status Report per SOP-DEV-implementation-workflow-v1.0 — no additional documentation gate.

3. Documentation Completion Procedure¶

Step 1 — Self-assessment (code.platform)¶

When code.platform closes the implementation phase, it runs through Section 2's change type table and identifies what documentation is required. Listed in the Status Report as: "Documentation required: {list}" and "Documentation completed: {list}."

Step 2 — Documentation authored¶

code.platform or the relevant subject-matter agent authors the required documentation: - Agent contracts: code.platform drafts; CDO reviews for contracts in the CDO department; other execs review their own department agents' contracts - SOPs: routed to sop.manager per normal SOP authoring flow - Knowledge articles: documentation.engineering curates and files per SOP-MKT-knowledge-curation-cadence-v1.0 - Decision Records: chief.staff or CDO as applicable

Step 3 — documentation.engineering signoff¶

For any documentation filed to knowledge/ (articles, DRs, tool guides, integration guides):

documentation.engineering confirms: 1. The artifact is in the correct vault path (per SOP-MKT-knowledge-curation-cadence-v1.0 Section 2 routing table) 2. The artifact meets minimum quality bar: complete sentences, clear scope, correct frontmatter 3. The artifact is indexed in the relevant INDEX.md file 4. If publication is required: MkDocs nav is updated per SOP-DEV-mkdocs-publication-v1.0

documentation.engineering logs signoff as an update to the associated Monday.com item: Documentation signoff: [YYYY-MM-DD] — {artifact path}

Step 4 — Monday.com item close¶

The development Monday.com item (feature or task) can only be marked Done after: - All required documentation per Section 2 is filed - documentation.engineering signoff logged (for knowledge/ artifacts) - Status Report reflects documentation complete

code.platform adds a completion note: "Documentation complete: {list of artifacts filed}" before marking Done.

4. Documentation Debt¶

If documentation is deferred (time pressure, blocker, external dependency):

A Monday.com sub-item is created: "Doc debt — {description}" with owner and deadline
The parent task remains In Progress in Monday.com until the sub-item is closed
code.platform flags the doc debt in their Status Report
CDO tracks doc debt items in the weekly Friday Close

Documentation debt is not a free pass. It is a tracked liability with a deadline.

5. MkDocs Publication¶

For documentation that should be published to the external-facing documentation site:

documentation.engineering follows SOP-DEV-mkdocs-publication-v1.0 for the publication step. Content approval gates per that SOP apply — documentation.engineering does not self-publish without the required approvals.

Change Log¶

Version	Date	Change
v1.0	2026-04-21	Initial draft — sop.manager.

Owner: documentation.engineering Executive sponsor: cdo Drafted by: sop.manager Status: Draft — pending CDO review + approval Version: v1.0