Documentation Source of Truth¶
This page defines ownership rules for ConnectSoft documentation. It is the policy that keeps shared guidance out of individual template repositories while preserving implementation details where engineers need them.
Ownership Model¶
| Layer | Owner | Documentation responsibility |
|---|---|---|
| Canonical | ConnectSoft.Documentation |
Shared architecture, cross-cutting concerns, standards, technology guidance, and template governance. |
| Layer 2 | ConnectSoft.BaseTemplate |
Concrete implementation of canonical concepts in the reusable service kernel. |
| Layer 3 | Specialized template repos | Overlay-specific behavior, generated solution shape, domain deltas, and template-specific runbooks. |
| Generated solution | Generated repository | Curated local docs, selected inherited implementation references, and links to canonical docs. |
Rules¶
- A shared concern has one canonical page in
ConnectSoft.Documentation. - BaseTemplate pages must link to canonical concepts and describe only Layer 2 implementation details.
- Layer 3 pages must link to canonical and BaseTemplate pages and describe only template-specific deltas.
- Generated solutions should include curated docs, not a full copy of the documentation site.
- New feature flags, options, ApplicationModel extensions, template overlays, and generated projects must be mapped to documentation coverage before CI enforcement is enabled.
Canonical Page Requirements¶
Canonical pages must:
- use general ConnectSoft wording;
- avoid presenting BaseTemplate or MicroserviceTemplate as the only product;
- include implementation examples only when clearly labeled;
- declare a stable
canonicalIdin front matter; - link to implementation or overlay docs instead of embedding full implementation manuals.
Implementation Page Requirements¶
Layer 2 and Layer 3 implementation pages should include:
- canonical concept link;
- projects or files involved;
- options and configuration keys;
- feature flags or template parameters;
- related tests;
- local troubleshooting and runbook notes.
Generated Solution Docs¶
Generated solutions should receive:
- local getting started and runbook pages;
- generated feature documentation matrix;
- relevant BaseTemplate implementation references;
- Layer 3 overlay docs when the template has real deltas;
- central canonical links by default.
Offline snapshots of canonical docs are optional and should be explicitly enabled by a template manifest.