Skip to main content

Governance

Version: 1.0
Status: Approved
Owner: Platform Architecture Team
Last Updated: 2026-04-12
References: AGENT.md §15–16, system.md §9


1. Purpose

This document defines the governance model for all platform specifications: lifecycle management, change control, approval authority, and definition of done.


2. Specification Lifecycle

Draft → In Review → Approved → Implemented → Verified → Deprecated
StatusMeaning
DraftBeing authored; not ready for review
In ReviewUnder peer/stakeholder review
ApprovedFormally approved; authoritative
ImplementedCode deliverables complete
VerifiedTested and confirmed compliant with spec
DeprecatedSuperseded; retained for historical reference

3. RACI Matrix

ActivityPlatform ArchitectService LeadQA LeadDelivery Manager
Author platform specsR/ACCI
Author service specsCR/ACI
Review all specsARCI
Approve platform specsACCI
Approve service specsCACI
Change control decisionsACCR
Definition of done sign-offCRAI

R = Responsible, A = Accountable, C = Consulted, I = Informed


4. Change Control

4.1 Minor Changes (PATCH version bump)

  • Corrections to wording, assumptions, or open points that do not alter requirements.
  • Author updates the document and notifies the team in the relevant PR.
  • No formal approval required; reviewed as part of standard PR review.

4.2 Significant Changes (MINOR version bump)

  • New requirements added, or existing requirements clarified in a way that affects implementation.
  • Requires review and approval from the Service Lead (for service specs) or Platform Architect (for platform specs).
  • PR must reference the changed requirement IDs in the description.

4.3 Breaking Changes (MAJOR version bump)

  • Requirements removed or fundamentally changed.
  • Requires formal approval from Platform Architect + Delivery Manager.
  • Traceability matrix must be updated to reflect deprecated requirement IDs.
  • Migration notes must accompany the change.

5. Definition of Done

A service implementation is considered done when ALL of the following are true:

CriterionVerifier
All FR, NFR, TR, AR requirements status = Implemented in traceability matrixService Lead
Unit test coverage meets or exceeds thresholds (domain 90%, app 80%, infra 60%)QA Lead
Integration and contract tests pass in CIQA Lead
E2E tests covering all flows in solution_design.md passQA Lead
All Grafana dashboards deployed and showing dataInfra Team
Runbook published in docs/runbooks/<service>.mdService Lead
Secrets configured in Vault / K8s Secrets (not in code)Security / Infra
Kubernetes deployment, HPA, health probes verifiedInfra Team
OpenAPI spec published and versionedService Lead
All open points in architectural_requirements.md resolvedPlatform Architect
Traceability matrix status updated to VerifiedQA Lead

6. Commit Standards

All commits MUST use Conventional Commits format (AGENT.md §16):

<type>(<scope>): <description>

feat(sms-orchestrator): add retry pipeline with exponential backoff
fix(api-gateway): correct rate limit header parsing
chore(infra): update k8s HPA manifests for smpp-connector
docs(specs): update api-gateway api_design.md with new /v1/sms/status endpoint

Prohibited commit messages: fix stuff, update, misc changes, WIP without elaboration.


7. Spec Review Checklist

Before marking a spec as Approved, the reviewer MUST confirm:

  • Document header is complete (version, status, owner, date, references)
  • All requirement IDs follow the convention in _CONVENTIONS.md
  • Assumptions and open points section is present and populated
  • Diagrams render correctly in Mermaid
  • Traceability matrix rows reference valid epic/feature/story IDs
  • No sensitive data (credentials, PII) present in the document
  • Cross-references to other spec files use relative links

8. Tooling

ToolUse
GitHub PRsAll spec changes reviewed and merged
GitHub ActionsCI linting of Markdown (markdownlint)
JiraEpics, features, and user stories from epics.md, features.md, user_stories.md
ConfluenceOptional publishing target for approved specs
ADOImport via traceability_matrix.csv

9. Assumptions and Open Points

IDAssumption / Open PointOwnerResolution Date
A-001Jira project key and board structure TBDDelivery ManagerTBD
A-002Confluence space for spec publishing TBDPlatform ArchTBD
A-003Markdownlint config to be added to .github/Platform EngTBD