doc-ref

Included with Lifetime

$97 forever

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.

Writing & Docs

What this skill does


# 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

1. **Determine the parent type** — business context → BRD-REF; architecture
   context → ADR-REF.
2. **Allocate the next number** — `ls docs/01_BRD/*-REF-* 2>/dev/null` (or
   `05_ADR`) and take the next free `NN`.
3. **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.
4. **Place** the file in the parent type directory with the correct H1.

### Required sections (4, mandatory)

1. YAML frontmatter (`artifact_type: REF`).
2. Document Control (version, date, author, status).
3. Document Revision History.
4. 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`

Files: 1

Size: 3.7 KB

Complexity: 13/100

Category: Writing & Docs

Source: https://github.com/vladm3105/aidoc-flow-framework/tree/main/platforms/claude-code-plugin/skills/doc-ref

Related in Writing & Docs

jax-development

Included

Use this skill when the user is writing, debugging, profiling, refactoring, reviewing, benchmarking, parallelising, exporting, or explaining JAX code, or when they mention JAX, jax.numpy, jit, grad, value_and_grad, vmap, scan, lax, random keys, pytrees, jax.Array, sharding, Mesh, PartitionSpec, NamedSharding, pmap, shard_map, Pallas, XLA, StableHLO, checkify, profiler, or the JAX repo. It helps turn NumPy or PyTorch-style code into pure functional JAX, fix tracer/control-flow/shape/PRNG bugs, remove recompiles and host-device syncs, choose transforms and sharding strategies, inspect jaxpr/lowering/IR, and benchmark compiled code correctly.

Writing & Docsscripts

nature-article-writer

Included

Drafts, rewrites, diagnostically critiques, and style-calibrates primary research manuscripts for Nature and Nature Portfolio journals. Use when the user wants a Nature-style title, summary paragraph or abstract, introduction, results, discussion, methods, figure legends, presubmission enquiry, cover letter, reviewer response, or when a scientific draft sounds generic, jargon-heavy, structurally weak, or AI-ish and needs precise, broad-reader-friendly prose without inventing data, analyses, or references. Best for primary research articles and letters rather than reviews or press releases unless explicitly adapting one.

Writing & Docsscripts

deckrd

Included

Document-driven framework that derives requirements, specifications, implementation plans, and executable tasks from goals through structured AI dialogue. Use when user says "write requirements", "create spec", "plan implementation", "derive tasks", "structure this feature", "break down into tasks", or "document this module". Also use for reverse engineering existing code into docs (/deckrd rev). Do NOT use for direct code writing — use /deckrd-coder after tasks are generated. Do NOT use when the user only wants to run or fix existing code without planning.

Writing & Docsscripts

clinical-decision-support

Included

Generate professional clinical decision support (CDS) documents for pharmaceutical and clinical research settings, including patient cohort analyses (biomarker-stratified with outcomes) and treatment recommendation reports (evidence-based guidelines with decision algorithms). Supports GRADE evidence grading, statistical analysis (hazard ratios, survival curves, waterfall plots), biomarker integration, and regulatory compliance. Outputs publication-ready LaTeX/PDF format optimized for drug development, clinical research, and evidence synthesis.

Writing & Docsscripts

handling-sf-data

Included

Salesforce data operations with 130-point scoring. Use this skill to create, update, delete, bulk import/export, generate test data, and clean up org records using sf CLI and anonymous Apex. TRIGGER when: user creates test data, performs bulk import/export, uses sf data CLI commands, needs data factory patterns for Apex tests, or needs to seed/clean records in a Salesforce org. DO NOT TRIGGER when: SOQL query writing only (use querying-soql), Apex test execution (use running-apex-tests), or metadata deployment (use deploying-metadata).

Writing & Docsscripts

accelint-ac-to-playwright

Included

Convert and validate acceptance criteria for Playwright test automation. Use when user asks to (1) review/evaluate/check if AC are ready for automation, (2) assess if AC can be converted as-is, (3) validate AC quality for Playwright, (4) turn AC into tests, (5) generate tests from acceptance criteria, (6) convert .md bullets or .feature Gherkin files to Playwright specs, (7) create test automation from requirements. Handles both bullet-style markdown and Gherkin syntax with JSON test plan generation and validation.

Writing & Docsscripts