Documentation Coverage Backlog¶
This backlog tracks topics discovered in ConnectSoft.BaseTemplate and Layer 3 templates that need canonical coverage, cleanup, or implementation-page separation.
Coverage States¶
| State | Meaning |
|---|---|
covered |
A canonical page exists and is general enough for all applicable templates. |
partial |
A canonical page exists but lacks important implementation or template behavior. |
template-specific |
A central page exists but reads like a BaseTemplate or MicroserviceTemplate implementation manual. |
missing |
A feature exists in code or templates but has no canonical documentation. |
obsolete |
The doc or nav entry exists but the feature is no longer active or the nav target is broken. |
Initial Backfill Candidates¶
| Topic | Current state | Target canonical area | Action |
|---|---|---|---|
| Dapper persistence | partial | architecture/technology/persistence |
Add a dedicated canonical Dapper page or expand persistence guidance with Dapper as a first-class option. |
| Serilog provider guidance | partial | architecture/observability |
Split provider-specific Serilog guidance from generic logging concepts. |
| Log4Net provider guidance | partial | architecture/observability |
Document when Log4Net is supported and how it differs from Serilog. |
| Logging Attributes | partial | architecture/observability |
Document attribute/AOP-style logging as a cross-cutting concern. |
| AI Evaluation | partial | cross-cutting-concerns/ai-machine-learning |
Add canonical AI evaluation guidance linked from AI extensions docs. |
| Agent Skills | partial | cross-cutting-concerns/ai-machine-learning |
Document reusable agent skill packaging and discovery guidance. |
| CoreWCF | partial | architecture/communication |
Confirm canonical CoreWCF page is general and linked from template docs. |
| Service Fabric | template-specific | architecture/infrastructure |
Generalize current content and mark template examples explicitly. |
| Resource Monitoring | template-specific | architecture/observability |
Generalize current content and move template details to implementation examples. |
| Latency Monitoring | partial | architecture/observability |
Promote latency telemetry/monitoring to canonical guidance. |
| Startup Warmup | partial | cross-cutting-concerns/system-reliability |
Add canonical warmup/readiness guidance, keeping template-specific startup pages as overlays. |
| Template Canvas and Features pages | missing | starters |
Define what belongs in canvas/features pages and how generated docs should use them. |
| Build and packaging docs | partial | starters and template implementation docs |
Split generic authoring guidance from repo-specific pack/install commands. |
Inventory Sources¶
Coverage inventory must scan:
- markdown files in BaseTemplate and Layer 3 repos;
mkdocs.ymlnavigation entries;.template.config/template.json;Directory.Build.props,Directory.Build.targets, andDirectory.Packages.props;- template-specific
build/*.props; - solution files;
- ApplicationModel extension classes;
- options classes;
- test projects and acceptance features.
Enforcement Criteria¶
Before CI blocks undocumented features, the generated coverage report must show:
- no active feature with state
missing; - no canonical page marked
template-specific; - no broken template nav targets;
- no duplicate docs directory casing in a single repo;
- all manifests present for BaseTemplate and Layer 3 templates.