76 lines
4.4 KiB
Markdown
76 lines
4.4 KiB
Markdown
# GovOPlaN Documentation Map
|
|
|
|
This directory contains cross-repository product, architecture, release, and
|
|
operational documentation. The map below defines which document answers which
|
|
question. A document not listed as the current status source must not present
|
|
volatile repository, issue, release, or maturity counts as current facts.
|
|
|
|
## Strategy
|
|
|
|
| Question | Canonical source |
|
|
| --- | --- |
|
|
| What are the stable ideas and boundaries of the platform? | [Platform Core Ideas](PLATFORM_CORE_IDEAS.md) |
|
|
| What product outcomes should GovOPlaN pursue? | [Connected Governance Platform Roadmap](CONNECTED_GOVERNANCE_PLATFORM_ROADMAP.md) |
|
|
| Which institutional concepts and owners form the target architecture? | [Institutional Governance Target Architecture](INSTITUTIONAL_GOVERNANCE_TARGET_ARCHITECTURE.md) |
|
|
| Which end-to-end proofs should guide implementation? | [Reference Journey Program](REFERENCE_JOURNEY_PROGRAM.md) |
|
|
| What is the reconciled state now? | [Strategy Status](STRATEGY_STATUS.md) |
|
|
|
|
The dated [Strategic Review](STRATEGIC_REVIEW_2026-08-05.md) explains why the
|
|
current reset and sequencing were chosen. It is an assessment record, not a
|
|
second live status page.
|
|
|
|
## Product Architecture
|
|
|
|
| Topic | Canonical source |
|
|
| --- | --- |
|
|
| Product-facing experience and hiding technical module boundaries | [Product Experience and Module Boundaries](PRODUCT_EXPERIENCE_AND_MODULE_BOUNDARIES.md) |
|
|
| Federation between autonomous installations | [Federated GovOPlaN Architecture](FEDERATED_GOVOPLAN_ARCHITECTURE.md) |
|
|
| Institutional digital twin and continuous assurance | [Institutional Digital Twin](INSTITUTIONAL_DIGITAL_TWIN.md) |
|
|
| Assisted and non-digital channels | [Assisted and Non-Digital Channels](ASSISTED_AND_NON_DIGITAL_CHANNELS.md) |
|
|
| Cross-module temporal, purpose, retention, and institutional-context adoption | `govoplan-core/docs/INFORMATION_GOVERNANCE_ADOPTION.md` |
|
|
| eAkte and digital-record ownership | `govoplan-records/docs/EAKTE_ARCHITECTURE.md` |
|
|
| Data source, definition, and transformation graph | [Datasource and Definition Graph Architecture](DATASOURCE_AND_DEFINITION_GRAPH_ARCHITECTURE.md) |
|
|
| Focused task views | [Views Architecture](VIEWS_ARCHITECTURE.md) |
|
|
| Shared interface patterns | [Interface Pattern Language](INTERFACE_PATTERN_LANGUAGE.md) |
|
|
|
|
## Runtime And Delivery
|
|
|
|
- [Module Contracts and Installs](MODULE_CONTRACTS_AND_INSTALLS.md)
|
|
- [Platform Control Plane](PLATFORM_CONTROL_PLANE.md)
|
|
- [Installation and Deployment Architecture](INSTALLATION_AND_DEPLOYMENT_ARCHITECTURE.md)
|
|
- [Kubernetes VM Test Lab](KUBERNETES_TEST_LAB.md)
|
|
- [Scaling and Multi-Host Deployment](SCALING_AND_MULTI_HOST_DEPLOYMENT.md)
|
|
- [Recovery and Rollback Guarantees](RECOVERY_AND_ROLLBACK_GUARANTEES.md)
|
|
- [Recovery Ledger Adoption](RECOVERY_LEDGER_ADOPTION.md)
|
|
- [Package Registry Releases](PACKAGE_REGISTRY_RELEASES.md)
|
|
|
|
## Evidence And Snapshots
|
|
|
|
These documents are intentionally dated or pinned. They may remain useful even
|
|
after the product changes, but they do not override `STRATEGY_STATUS.md`.
|
|
|
|
- [Capability and Infrastructure Fit Assessment](CAPABILITY_AND_INFRASTRUCTURE_FIT.md), pinned to the 2026-07-22 Campaign composition
|
|
- [Strategic Review 2026-08-05](STRATEGIC_REVIEW_2026-08-05.md)
|
|
- [Backup and Restore Evidence](BACKUP_AND_RESTORE_EVIDENCE.md)
|
|
- [Production Target Handoff](PRODUCTION_TARGET_HANDOFF.md)
|
|
- [Target Maturity Evidence Runbook](TARGET_MATURITY_EVIDENCE_RUNBOOK.md)
|
|
|
|
Machine-readable schemas and evidence files belong beside the document that
|
|
defines them. Generated inventories belong in `audit-reports/` and should not
|
|
be edited manually.
|
|
|
|
## Maintenance Rules
|
|
|
|
1. Gitea issues are the only live work-state source.
|
|
2. `STRATEGY_STATUS.md` is the only prose reconciliation of current portfolio
|
|
state. Refresh it from manifests, inventories, tests, and Gitea; do not copy
|
|
its counts into durable architecture pages.
|
|
3. Durable documents state decisions, invariants, ownership, and acceptance
|
|
gates. They link to status and issues for implementation depth.
|
|
4. Dated assessments retain their original composition and conclusion. Add a
|
|
snapshot notice rather than silently updating their claims.
|
|
5. Module-specific behavior and user/admin documentation remain in the owning
|
|
repository. Meta documentation defines cross-module outcomes and contracts.
|
|
6. A new strategy document must replace, narrow, or link an existing source;
|
|
it must not introduce a parallel roadmap.
|