About

Imported from vladm3105/aidoc-flow-framework (platforms/claude-code-plugin/skills/doc-ref/SKILL.md). Install upstream with npx skills add vladm3105/aidoc-flow-framework --skill doc-ref. Copyright stays with the author.

doc-ref

Name: doc-ref
Author: vladm3105

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

Use it

Copy one of these into your project. Installing also returns the manifest and these snippets.

yaml

targets:
  - https://api.opensmartroute.ai/api/v1/registry/vladm3105-aidoc-flow-framework-doc-ref/manifest   # or paste the manifest below

Manifest

An Open Capability Manifest: the router reads it to know what this does, what it costs and when to pick it.

vladm3105-aidoc-flow-framework-doc-ref.ocm.jsonjson

{
  "ocm": "1",
  "id": "vladm3105-aidoc-flow-framework-doc-ref",
  "kind": "skill",
  "name": "doc-ref",
  "description": "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.",
  "publisher": "vladm3105",
  "version": "1.0.0",
  "capabilities": {
    "domains": [
      "general"
    ],
    "tags": [
      "skill-md",
      "sdd-workflow",
      "utility",
      "skills-sh"
    ],
    "languages": [
      "en"
    ]
  },
  "quality_prior": 0.6,
  "examples": [
    "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."
  ],
  "primary": false,
  "metadata": {
    "source": {
      "provider": "skills.sh",
      "repository": "https://github.com/vladm3105/aidoc-flow-framework",
      "path": "platforms/claude-code-plugin/skills/doc-ref/SKILL.md",
      "ref": "HEAD",
      "url": "https://github.com/vladm3105/aidoc-flow-framework/blob/HEAD/platforms/claude-code-plugin/skills/doc-ref/SKILL.md",
      "key": "vladm3105/aidoc-flow-framework/platforms/claude-code-plugin/skills/doc-ref/SKILL.md"
    }
  },
  "instructions": "# doc-ref\n\n## Purpose\n\nCreate **Reference Documents (REF)** — free-format supplementary documents that\nsupport a **BRD or ADR** without participating in the formal traceability\nchain. REF documents provide context (overviews, summaries, guides); they carry\nno element IDs, cumulative tags, ready-scores, or quality gates.\n\n**Layer**: cross-cutting utility — REF documents are limited to **BRD and ADR\nparent types only**.\n\n## When to Use\n\n**Use** `doc-ref` for supplements such as:\n\n- **BRD-REF** — project overviews, executive summaries, strategic vision,\n  stakeholder guides.\n- **ADR-REF** — techn",
  "cost": {
    "context_tokens": 820
  }
}

Fetch it by URL: GET /api/v1/registry/vladm3105-aidoc-flow-framework-doc-ref/manifest?version=1.0.0

Reviews

Star ratings from people who tried it. One review per account; edit yours any time.

No reviews yet. Install it, try it, and be the first to rate it.