Document maintenance protocol
Document maintenance protocol
Section titled “Document maintenance protocol”This is a Tier 1 normative document.
It defines how the planning-meta corpus is maintained over time.
Purpose
Section titled “Purpose”Prevent planning-document drift, contradiction, and abandonment.
Corpus governed by this protocol
Section titled “Corpus governed by this protocol”All documents in docs/src/architecture/planning-meta/.
Ownership model
Section titled “Ownership model”Each document must define:
- owner role,
- backup owner role,
- update cadence,
- authority tier.
Owner role is accountable for correctness; backup owner role is accountable for continuity.
Update cadence
Section titled “Update cadence”Default cadence by tier:
- Tier 1: review every major planning revision or milestone boundary.
- Tier 2: review each active planning cycle.
- Tier 3: review when source findings/terminology change.
Any doc older than one cadence window without review is “stale”.
Change categories
Section titled “Change categories”- Patch change: clarifications and non-semantic edits.
- Minor change: new sections or expanded requirements with no authority inversion.
- Major change: authority change, gate definition change, or blocker policy change.
Major changes require explicit cross-document consistency pass.
Versioning convention
Section titled “Versioning convention”Use per-document version metadata in maintenance log:
major.minor.patch- increment major on authority or normative rule change,
- increment minor on requirements expansion,
- increment patch on corrections/clarifications.
Supersession and archival
Section titled “Supersession and archival”When replacing a document:
- mark old document as superseded,
- link to replacement document,
- update master index,
- retain historical artifact for traceability.
No silent replacement is allowed.
Consistency protocol
Section titled “Consistency protocol”After any Tier 1 change:
- run cross-document term consistency check,
- run authority conflict check,
- run gate-definition alignment check,
- run exception-policy compatibility check.
Record outcomes in maintenance log.
Maintenance log requirements
Section titled “Maintenance log requirements”Maintenance log entry should include:
- date,
- changed documents,
- change category,
- rationale,
- impacted documents,
- unresolved follow-ups.
Canonical maintenance artifacts:
- Maintenance log:
docs/src/architecture/planning-meta/maintenance-log.md - Exception register:
docs/src/architecture/planning-meta/exception-register.md
If either artifact is missing, Tier 1 updates are blocked until restored.
Maintenance log entry template:
date: YYYY-MM-DDchange_id: PM-####changed_docs: - <doc path>change_category: patch|minor|majorrationale: <why>impacted_docs: - <doc path>follow_ups: - <item>approver_role: <role>Staleness handling
Section titled “Staleness handling”When a document is stale:
- flag stale state in index,
- assign owner action item,
- either refresh, supersede, or archive with rationale.
Requesting rewrites
Section titled “Requesting rewrites”A rewrite request must include:
- target documents,
- reason for rewrite,
- scope boundaries,
- desired output shape,
- urgency level.
Rewrites that touch Tier 1 docs require governance review before acceptance.
Acceptance criteria
Section titled “Acceptance criteria”This protocol is active when:
- every planning-meta document has ownership and cadence,
- major changes trigger mandatory consistency pass,
- supersession and archival are explicitly recorded,
- stale documents are visible and actionable.