generated from coulomb/repo-seed
Bootstrap and first implementation
This commit is contained in:
119
templates/capability-entry.template.md
Normal file
119
templates/capability-entry.template.md
Normal file
@@ -0,0 +1,119 @@
|
||||
---
|
||||
# Copy this file to registry/capabilities/<id-with-dots-as-hyphens>.md
|
||||
# Replace placeholder values. Keep external_evidence separate from maturity.
|
||||
id: capability.domain.example
|
||||
name: Example Capability
|
||||
summary: One sentence describing what this capability enables.
|
||||
owner: team-or-person
|
||||
status: draft
|
||||
domain: helix_forge
|
||||
tags:
|
||||
- example
|
||||
|
||||
maturity:
|
||||
discovery:
|
||||
current: D0
|
||||
target: D5
|
||||
confidence: low
|
||||
rationale: >
|
||||
Explain why the current discovery level is defensible and what evidence
|
||||
is still missing for promotion.
|
||||
availability:
|
||||
current: A0
|
||||
target: A3
|
||||
confidence: low
|
||||
rationale: >
|
||||
Explain the current consumption mode and the natural target availability.
|
||||
|
||||
external_evidence:
|
||||
completeness:
|
||||
level: C0
|
||||
confidence: low
|
||||
basis: scope_vs_intent_and_consumer_expectations
|
||||
satisfied_expectations: []
|
||||
broken_expectations: []
|
||||
out_of_scope_expectations: []
|
||||
reliability:
|
||||
level: R0
|
||||
confidence: low
|
||||
basis: consumer_quality_signals
|
||||
known_reliability_risks: []
|
||||
|
||||
discovery:
|
||||
intent: >
|
||||
What this capability is meant to make possible for planners and consumers.
|
||||
includes:
|
||||
- behavior that belongs inside the capability
|
||||
excludes:
|
||||
- behavior explicitly outside the capability
|
||||
assumptions:
|
||||
- assumptions shaping the capability boundary
|
||||
use_cases: []
|
||||
research_memos: []
|
||||
|
||||
availability:
|
||||
current_level: A0
|
||||
target_level: A3
|
||||
current_artifacts: []
|
||||
target_artifacts: []
|
||||
consumption_modes:
|
||||
- informational
|
||||
|
||||
relations:
|
||||
depends_on: []
|
||||
supports: []
|
||||
related_to: []
|
||||
|
||||
evidence:
|
||||
documentation: []
|
||||
tests: []
|
||||
consumer_feedback: []
|
||||
bug_reports: []
|
||||
incidents: []
|
||||
|
||||
consumer_guidance:
|
||||
recommended_for:
|
||||
- describe suitable reuse scenarios
|
||||
not_recommended_for:
|
||||
- describe unsafe or weak reuse scenarios
|
||||
known_limitations:
|
||||
- list known gaps, risks, or missing evidence
|
||||
---
|
||||
|
||||
# Example Capability
|
||||
|
||||
## Overview
|
||||
|
||||
Describe the capability in plain language for human readers. The YAML front
|
||||
matter above is the machine-readable source of truth for maturity, evidence,
|
||||
relations, and consumer guidance.
|
||||
|
||||
## Assessment notes
|
||||
|
||||
### Discovery
|
||||
|
||||
Record why the selected discovery level is defensible. Link research memos,
|
||||
use cases, and scope boundaries that support promotion.
|
||||
|
||||
### Availability
|
||||
|
||||
Record how consumers can access the capability today and what artifact would
|
||||
raise availability to the target level.
|
||||
|
||||
### Completeness
|
||||
|
||||
Compare declared intent, current scope, and consumer expectations. Record broken
|
||||
expectations explicitly rather than hiding them.
|
||||
|
||||
### Reliability
|
||||
|
||||
Record consumer-relevant quality evidence. Do not confuse reliability with
|
||||
completeness or internal code quality.
|
||||
|
||||
## Promotion checklist
|
||||
|
||||
- [ ] ID follows `capability.<domain>.<name>` pattern
|
||||
- [ ] Maturity enums match `specs/CapabilityMaturityStandard.md`
|
||||
- [ ] `external_evidence` is populated separately from `maturity`
|
||||
- [ ] Relations reference valid capability IDs
|
||||
- [ ] Index entry added or updated in `registry/indexes/capabilities.yaml`
|
||||
Reference in New Issue
Block a user