Template Documentation Policy¶
Template documentation must separate reusable guidance from implementation and overlay details.
Page Types¶
| Page type | Owner | Purpose |
|---|---|---|
| Canonical concept | ConnectSoft.Documentation |
Shared concepts, architecture, standards, and cross-cutting guidance. |
| Layer 2 implementation | ConnectSoft.BaseTemplate |
How BaseTemplate implements canonical concepts. |
| Layer 3 overlay | Specialized template repo | How the template differs from BaseTemplate. |
| Generated solution | Generated repo | Local usage, runbook, and curated references for enabled features. |
Canvas and Features Pages¶
Template canvas and features pages should be concise entry points:
- product or template identity;
- intended audience;
- generated capabilities;
- links to canonical and implementation docs;
- feature matrix summary.
They should not duplicate canonical explanations of observability, resilience, security, persistence, messaging, or AI.
Build and Packaging Pages¶
Generic authoring guidance belongs in ConnectSoft.Documentation. Repo-specific commands remain in the owning template repo.
Examples:
- canonical: how ConnectSoft templates are layered, packaged, and documented;
- BaseTemplate: exact package/install commands for BaseTemplate;
- Layer 3: overlay-specific package/install commands and submodule requirements.