doc-ref
Purpose
Create Reference Documents (REF) — free-format supplementary documents that
support a BRD or ADR without participating in the formal traceability
chain. REF documents provide context (overviews, summaries, guides); they carry
no element IDs, cumulative tags, ready-scores, or quality gates.
Layer: cross-cutting utility — REF documents are limited to BRD and ADR
parent types only.
When to Use
Use doc-ref for supplements such as:
- BRD-REF — project overviews, executive summaries, strategic vision,
stakeholder guides.
- ADR-REF — technology-stack summaries, architecture overviews,
infrastructure guides.
Do NOT use for: anything that should participate in traceability; core
artifacts (BRD/PRD/EARS/BDD/ADR/SPEC/TDD/IPLAN — use their doc-* skills); or
any parent type other than BRD or ADR.
Behavior
Naming and location
- File name:
{TYPE}-REF-NN_{slug}.md (TYPE ∈ {BRD, ADR}); H1:
# {TYPE}-REF-NN: Title.
NN is a variable-length sequence (2+ digits), independent per parent type:
BRD-REF-01, BRD-REF-102, ADR-REF-01 are separate sequences.- Located inside the parent type directory, e.g.
docs/01_BRD/BRD-REF-01_project_overview.md,
docs/05_ADR/ADR-REF-01_technology_stack_summary.md.
- Regex — file:
^(BRD|ADR)-REF-[0-9]{2,}_[a-z0-9_]+\.md$;
H1: ^#\s(BRD|ADR)-REF-[0-9]{2,}:.+$.
Creation process
- Determine the parent type — business context → BRD-REF; architecture
context → ADR-REF.
- Allocate the next number —
ls docs/01_BRD/*-REF-* 2>/dev/null (or
05_ADR) and take the next free NN.
- Draft from the parent template, stripped to REF essentials — start from
${CLAUDE_PLUGIN_ROOT}/framework/layers/01_BRD/BRD-TEMPLATE.yaml (BRD-REF) or
${CLAUDE_PLUGIN_ROOT}/framework/layers/05_ADR/ADR-TEMPLATE.yaml (ADR-REF) and keep only the four
mandatory sections, dropping the traceability scaffolding.
- Place the file in the parent type directory with the correct H1.
Required sections (4, mandatory)
- YAML frontmatter (
artifact_type: REF).
- Document Control (version, date, author, status).
- Document Revision History.
- Introduction (purpose and scope).
Optional: Related Documents (cross-references encouraged) and any content
sections the reference material needs.
Validation (this skill is the validator)
Blocking checks only: H1 matches {TYPE}-REF-NN: Title; Document Control,
Revision History, and Introduction sections are present. Exempt (not
checked): cumulative tags, full traceability, quality gates, ready-scores —
REF documents do not participate in the chain. No element IDs apply.
Related Resources
- Parent templates:
${CLAUDE_PLUGIN_ROOT}/framework/layers/01_BRD/BRD-TEMPLATE.yaml,
${CLAUDE_PLUGIN_ROOT}/framework/layers/05_ADR/ADR-TEMPLATE.yaml
- Naming authority:
${CLAUDE_PLUGIN_ROOT}/framework/governance/ID_NAMING_STANDARDS.md ·
../doc-naming/SKILL.md
- Governance & per-layer authority:
${CLAUDE_PLUGIN_ROOT}/framework/governance/ and each
${CLAUDE_PLUGIN_ROOT}/framework/layers/NN_<X>/README.md
- Parent skills:
../doc-brd/SKILL.md · ../doc-adr/SKILL.md
- Workflow routing:
../doc-flow/SKILL.md
- Diagrams:
../charts-flow/SKILL.md
1---2name: doc-ref3description: Create Reference Documents (REF) - free-format supplements for BRD and ADR that sit outside the formal traceability chain. Use for project overviews, strategic vision, or technology/infrastructure summaries.4---5
6# doc-ref
7
8## Purpose
9
10Create **Reference Documents (REF)** — free-format supplementary documents that
11support a **BRD or ADR** without participating in the formal traceability
12chain. REF documents provide context (overviews, summaries, guides); they carry
13no element IDs, cumulative tags, ready-scores, or quality gates.
14
15**Layer**: cross-cutting utility — REF documents are limited to **BRD and ADR
16parent types only**.
17
18## When to Use
19
20**Use** `doc-ref` for supplements such as:
21
22- **BRD-REF** — project overviews, executive summaries, strategic vision,
23 stakeholder guides.
24- **ADR-REF** — technology-stack summaries, architecture overviews,
25 infrastructure guides.
26
27**Do NOT use** for: anything that should participate in traceability; core
28artifacts (BRD/PRD/EARS/BDD/ADR/SPEC/TDD/IPLAN — use their `doc-*` skills); or
29any parent type other than BRD or ADR.
30
31## Behavior
32
33### Naming and location
34
35- File name: `{TYPE}-REF-NN_{slug}.md` (`TYPE` ∈ {BRD, ADR}); H1:
36 `# {TYPE}-REF-NN: Title`.
37- `NN` is a variable-length sequence (2+ digits), independent per parent type:
38 `BRD-REF-01`, `BRD-REF-102`, `ADR-REF-01` are separate sequences.
39- Located inside the parent type directory, e.g.
40 `docs/01_BRD/BRD-REF-01_project_overview.md`,
41 `docs/05_ADR/ADR-REF-01_technology_stack_summary.md`.
42- Regex — file: `^(BRD|ADR)-REF-[0-9]{2,}_[a-z0-9_]+\.md$`;
43 H1: `^#\s(BRD|ADR)-REF-[0-9]{2,}:.+$`.
44
45### Creation process
46
471. **Determine the parent type** — business context → BRD-REF; architecture
48 context → ADR-REF.
492. **Allocate the next number** — `ls docs/01_BRD/*-REF-* 2>/dev/null` (or
50 `05_ADR`) and take the next free `NN`.
513. **Draft from the parent template, stripped to REF essentials** — start from
52 `${CLAUDE_PLUGIN_ROOT}/framework/layers/01_BRD/BRD-TEMPLATE.yaml` (BRD-REF) or
53 `${CLAUDE_PLUGIN_ROOT}/framework/layers/05_ADR/ADR-TEMPLATE.yaml` (ADR-REF) and keep only the four
54 mandatory sections, dropping the traceability scaffolding.
554. **Place** the file in the parent type directory with the correct H1.
56
57### Required sections (4, mandatory)
58
591. YAML frontmatter (`artifact_type: REF`).
602. Document Control (version, date, author, status).
613. Document Revision History.
624. Introduction (purpose and scope).
63
64Optional: Related Documents (cross-references encouraged) and any content
65sections the reference material needs.
66
67### Validation (this skill is the validator)
68
69Blocking checks only: H1 matches `{TYPE}-REF-NN: Title`; Document Control,
70Revision History, and Introduction sections are present. **Exempt** (not
71checked): cumulative tags, full traceability, quality gates, ready-scores —
72REF documents do not participate in the chain. No element IDs apply.
73
74## Related Resources
75
76- Parent templates: `${CLAUDE_PLUGIN_ROOT}/framework/layers/01_BRD/BRD-TEMPLATE.yaml`,
77 `${CLAUDE_PLUGIN_ROOT}/framework/layers/05_ADR/ADR-TEMPLATE.yaml`
78- Naming authority: `${CLAUDE_PLUGIN_ROOT}/framework/governance/ID_NAMING_STANDARDS.md` ·
79 `../doc-naming/SKILL.md`
80- Governance & per-layer authority: `${CLAUDE_PLUGIN_ROOT}/framework/governance/` and each
81 `${CLAUDE_PLUGIN_ROOT}/framework/layers/NN_<X>/README.md`
82- Parent skills: `../doc-brd/SKILL.md` · `../doc-adr/SKILL.md`
83- Workflow routing: `../doc-flow/SKILL.md`
84- Diagrams: `../charts-flow/SKILL.md`
vladm3105