Metadata Tag Reference
Purpose: Complete metadata tag definitions with all fields
Metadata Tag Definitions
Section titled “Metadata Tag Definitions”53 metadata tags with full details.
| Tag | Format | Purpose | Required | Repeatable | Values | Default |
|---|---|---|---|---|---|---|
pattern | value | Explicit pattern name | Yes | No | - | - |
status | enum | Work item lifecycle status (per PDR-005 FSM) | No | No | roadmap, active, completed, deferred | roadmap |
core | flag | Marks as essential/must-know pattern | No | No | - | - |
usecase | quoted-value | Use case association | No | Yes | - | - |
uses | csv | Patterns this depends on | No | No | - | - |
used-by | csv | Patterns that depend on this | No | No | - | - |
phase | number | Roadmap phase number (unified across monorepo) | No | No | - | - |
release | value | Target release version (semver or vNEXT for unreleased work) | No | No | - | - |
brief | value | Path to pattern brief markdown | No | No | - | - |
depends-on | csv | Roadmap dependencies (pattern or phase names) | No | No | - | - |
enables | csv | Patterns this enables | No | No | - | - |
implements | csv | Patterns this code file realizes (realization relationship) | No | No | - | - |
extends | value | Base pattern this pattern extends (generalization relationship) | No | No | - | - |
quarter | value | Delivery quarter for timeline tracking | No | No | - | - |
completed | value | Completion date (YYYY-MM-DD format) | No | No | - | - |
effort | value | Estimated effort (4h, 2d, 1w format) | No | No | - | - |
effort-actual | value | Actual effort spent (4h, 2d, 1w format) | No | No | - | - |
team | value | Responsible team assignment | No | No | - | - |
workflow | enum | Workflow discipline for process tracking | No | No | implementation, planning, validation, documentation | - |
risk | enum | Risk level for planning | No | No | low, medium, high | - |
priority | enum | Priority level for roadmap ordering | No | No | critical, high, medium, low | - |
product-area | value | Product area for PRD grouping | No | No | - | - |
user-role | value | Target user persona for this feature | No | No | - | - |
business-value | value | Business value statement (hyphenated for tag format) | No | No | - | - |
constraint | value | Technical constraint affecting feature implementation | No | Yes | - | - |
adr | value | ADR/PDR number for decision tracking | No | No | - | - |
adr-status | enum | ADR/PDR decision status | No | No | proposed, accepted, deprecated, superseded | proposed |
adr-category | value | ADR/PDR category (architecture, process, tooling) | No | No | - | - |
adr-supersedes | value | ADR/PDR number this decision supersedes | No | No | - | - |
adr-superseded-by | value | ADR/PDR number that supersedes this decision | No | No | - | - |
adr-theme | enum | Theme grouping for related decisions (from synthesis) | No | No | persistence, isolation, commands, projections, coordination, taxonomy, testing | - |
adr-layer | enum | Evolutionary layer of the decision | No | No | foundation, infrastructure, refinement | - |
level | enum | Hierarchy level for epic->phase->task breakdown | No | No | epic, phase, task | phase |
parent | value | Parent pattern name in hierarchy (links tasks to phases, phases to epics) | No | No | - | - |
title | quoted-value | Human-readable display title (supports quoted values with spaces) | No | No | - | - |
executable-specs | csv | Links roadmap spec to package executable spec locations (PDR-007) | No | No | - | - |
roadmap-spec | value | Links package spec back to roadmap pattern for traceability (PDR-007) | No | No | - | - |
behavior-file | value | Path to behavior test feature file for traceability | No | No | - | - |
discovered-gap | value | Gap identified during session retrospective | No | Yes | - | - |
discovered-improvement | value | Improvement identified during session retrospective | No | Yes | - | - |
discovered-risk | value | Risk identified during session retrospective | No | Yes | - | - |
discovered-learning | value | Learning captured during session retrospective | No | Yes | - | - |
see-also | csv | Related patterns for cross-reference without dependency implication | No | No | - | - |
api-ref | csv | File paths to implementation APIs (replaces ‘See:’ Markdown text in Rules) | No | No | - | - |
extract-shapes | csv | TypeScript type names to extract from this file for documentation | No | No | - | - |
shape | value | Marks declaration as documentable shape, optionally with group name | No | No | - | - |
arch-role | enum | Architectural role for diagram generation (component type) | No | No | bounded-context, command-handler, projection, saga, process-manager, infrastructure, repository, decider, read-model, service | - |
arch-context | value | Bounded context this component belongs to (for subgraph grouping) | No | No | - | - |
arch-layer | enum | Architectural layer for layered diagrams | No | No | domain, application, infrastructure | - |
include | csv | Cross-cutting document inclusion for content routing and diagram scoping | No | No | - | - |
target | value | Target implementation path for stub files | No | No | - | - |
since | value | Design session that created this pattern | No | No | - | - |
convention | csv | Convention domains for reference document generation from decision records | No | No | testing-policy, fsm-rules, cli-patterns, output-format, pattern-naming, session-workflow, config-presets, annotation-system, pipeline-architecture, publishing, doc-generation, taxonomy-rules | - |
Tag Details
Section titled “Tag Details”pattern
Section titled “pattern”| Property | Value |
|---|---|
| Format | value |
| Purpose | Explicit pattern name |
| Required | Yes |
| Repeatable | No |
| Example | @libar-docs-pattern CommandOrchestrator |
status
Section titled “status”| Property | Value |
|---|---|
| Format | enum |
| Purpose | Work item lifecycle status (per PDR-005 FSM) |
| Required | No |
| Repeatable | No |
| Valid Values | roadmap, active, completed, deferred |
| Default | roadmap |
| Example | @libar-docs-status roadmap |
| Property | Value |
|---|---|
| Format | flag |
| Purpose | Marks as essential/must-know pattern |
| Required | No |
| Repeatable | No |
| Example | @libar-docs-core |
usecase
Section titled “usecase”| Property | Value |
|---|---|
| Format | quoted-value |
| Purpose | Use case association |
| Required | No |
| Repeatable | Yes |
| Example | @libar-docs-usecase "When handling command failures" |
| Property | Value |
|---|---|
| Format | csv |
| Purpose | Patterns this depends on |
| Required | No |
| Repeatable | No |
| Example | @libar-docs-uses CommandBus, EventStore |
used-by
Section titled “used-by”| Property | Value |
|---|---|
| Format | csv |
| Purpose | Patterns that depend on this |
| Required | No |
| Repeatable | No |
| Example | @libar-docs-used-by SagaOrchestrator |
| Property | Value |
|---|---|
| Format | number |
| Purpose | Roadmap phase number (unified across monorepo) |
| Required | No |
| Repeatable | No |
| Example | @libar-docs-phase 14 |
release
Section titled “release”| Property | Value |
|---|---|
| Format | value |
| Purpose | Target release version (semver or vNEXT for unreleased work) |
| Required | No |
| Repeatable | No |
| Example | @libar-docs-release v0.1.0 |
| Property | Value |
|---|---|
| Format | value |
| Purpose | Path to pattern brief markdown |
| Required | No |
| Repeatable | No |
| Example | @libar-docs-brief docs/briefs/decider-pattern.md |
depends-on
Section titled “depends-on”| Property | Value |
|---|---|
| Format | csv |
| Purpose | Roadmap dependencies (pattern or phase names) |
| Required | No |
| Repeatable | No |
| Example | @libar-docs-depends-on EventStore, CommandBus |
enables
Section titled “enables”| Property | Value |
|---|---|
| Format | csv |
| Purpose | Patterns this enables |
| Required | No |
| Repeatable | No |
| Example | @libar-docs-enables SagaOrchestrator, ProjectionBuilder |
implements
Section titled “implements”| Property | Value |
|---|---|
| Format | csv |
| Purpose | Patterns this code file realizes (realization relationship) |
| Required | No |
| Repeatable | No |
| Example | @libar-docs-implements EventStoreDurability, IdempotentAppend |
extends
Section titled “extends”| Property | Value |
|---|---|
| Format | value |
| Purpose | Base pattern this pattern extends (generalization relationship) |
| Required | No |
| Repeatable | No |
| Example | @libar-docs-extends ProjectionCategories |
quarter
Section titled “quarter”| Property | Value |
|---|---|
| Format | value |
| Purpose | Delivery quarter for timeline tracking |
| Required | No |
| Repeatable | No |
| Example | @libar-docs-quarter Q1-2026 |
completed
Section titled “completed”| Property | Value |
|---|---|
| Format | value |
| Purpose | Completion date (YYYY-MM-DD format) |
| Required | No |
| Repeatable | No |
| Example | @libar-docs-completed 2026-01-08 |
effort
Section titled “effort”| Property | Value |
|---|---|
| Format | value |
| Purpose | Estimated effort (4h, 2d, 1w format) |
| Required | No |
| Repeatable | No |
| Example | @libar-docs-effort 2d |
effort-actual
Section titled “effort-actual”| Property | Value |
|---|---|
| Format | value |
| Purpose | Actual effort spent (4h, 2d, 1w format) |
| Required | No |
| Repeatable | No |
| Example | @libar-docs-effort-actual 3d |
| Property | Value |
|---|---|
| Format | value |
| Purpose | Responsible team assignment |
| Required | No |
| Repeatable | No |
| Example | @libar-docs-team platform |
workflow
Section titled “workflow”| Property | Value |
|---|---|
| Format | enum |
| Purpose | Workflow discipline for process tracking |
| Required | No |
| Repeatable | No |
| Valid Values | implementation, planning, validation, documentation |
| Example | @libar-docs-workflow implementation |
| Property | Value |
|---|---|
| Format | enum |
| Purpose | Risk level for planning |
| Required | No |
| Repeatable | No |
| Valid Values | low, medium, high |
| Example | @libar-docs-risk medium |
priority
Section titled “priority”| Property | Value |
|---|---|
| Format | enum |
| Purpose | Priority level for roadmap ordering |
| Required | No |
| Repeatable | No |
| Valid Values | critical, high, medium, low |
| Example | @libar-docs-priority high |
product-area
Section titled “product-area”| Property | Value |
|---|---|
| Format | value |
| Purpose | Product area for PRD grouping |
| Required | No |
| Repeatable | No |
| Example | @libar-docs-product-area PlatformCore |
user-role
Section titled “user-role”| Property | Value |
|---|---|
| Format | value |
| Purpose | Target user persona for this feature |
| Required | No |
| Repeatable | No |
| Example | @libar-docs-user-role Developer |
business-value
Section titled “business-value”| Property | Value |
|---|---|
| Format | value |
| Purpose | Business value statement (hyphenated for tag format) |
| Required | No |
| Repeatable | No |
| Example | @libar-docs-business-value eliminates-event-replay-complexity |
constraint
Section titled “constraint”| Property | Value |
|---|---|
| Format | value |
| Purpose | Technical constraint affecting feature implementation |
| Required | No |
| Repeatable | Yes |
| Example | @libar-docs-constraint requires-convex-backend |
| Property | Value |
|---|---|
| Format | value |
| Purpose | ADR/PDR number for decision tracking |
| Required | No |
| Repeatable | No |
| Example | @libar-docs-adr 015 |
adr-status
Section titled “adr-status”| Property | Value |
|---|---|
| Format | enum |
| Purpose | ADR/PDR decision status |
| Required | No |
| Repeatable | No |
| Valid Values | proposed, accepted, deprecated, superseded |
| Default | proposed |
| Example | @libar-docs-adr-status accepted |
adr-category
Section titled “adr-category”| Property | Value |
|---|---|
| Format | value |
| Purpose | ADR/PDR category (architecture, process, tooling) |
| Required | No |
| Repeatable | No |
| Example | @libar-docs-adr-category architecture |
adr-supersedes
Section titled “adr-supersedes”| Property | Value |
|---|---|
| Format | value |
| Purpose | ADR/PDR number this decision supersedes |
| Required | No |
| Repeatable | No |
| Example | @libar-docs-adr-supersedes 012 |
adr-superseded-by
Section titled “adr-superseded-by”| Property | Value |
|---|---|
| Format | value |
| Purpose | ADR/PDR number that supersedes this decision |
| Required | No |
| Repeatable | No |
| Example | @libar-docs-adr-superseded-by 020 |
adr-theme
Section titled “adr-theme”| Property | Value |
|---|---|
| Format | enum |
| Purpose | Theme grouping for related decisions (from synthesis) |
| Required | No |
| Repeatable | No |
| Valid Values | persistence, isolation, commands, projections, coordination, taxonomy, testing |
| Example | @libar-docs-adr-theme persistence |
adr-layer
Section titled “adr-layer”| Property | Value |
|---|---|
| Format | enum |
| Purpose | Evolutionary layer of the decision |
| Required | No |
| Repeatable | No |
| Valid Values | foundation, infrastructure, refinement |
| Example | @libar-docs-adr-layer foundation |
| Property | Value |
|---|---|
| Format | enum |
| Purpose | Hierarchy level for epic->phase->task breakdown |
| Required | No |
| Repeatable | No |
| Valid Values | epic, phase, task |
| Default | phase |
| Example | @libar-docs-level epic |
parent
Section titled “parent”| Property | Value |
|---|---|
| Format | value |
| Purpose | Parent pattern name in hierarchy (links tasks to phases, phases to epics) |
| Required | No |
| Repeatable | No |
| Example | @libar-docs-parent AggregateArchitecture |
| Property | Value |
|---|---|
| Format | quoted-value |
| Purpose | Human-readable display title (supports quoted values with spaces) |
| Required | No |
| Repeatable | No |
| Example | @libar-docs-title:"Process Guard Linter" |
executable-specs
Section titled “executable-specs”| Property | Value |
|---|---|
| Format | csv |
| Purpose | Links roadmap spec to package executable spec locations (PDR-007) |
| Required | No |
| Repeatable | No |
| Example | @libar-docs-executable-specs platform-decider/tests/features/behavior |
roadmap-spec
Section titled “roadmap-spec”| Property | Value |
|---|---|
| Format | value |
| Purpose | Links package spec back to roadmap pattern for traceability (PDR-007) |
| Required | No |
| Repeatable | No |
| Example | @libar-docs-roadmap-spec DeciderPattern |
behavior-file
Section titled “behavior-file”| Property | Value |
|---|---|
| Format | value |
| Purpose | Path to behavior test feature file for traceability |
| Required | No |
| Repeatable | No |
| Example | @libar-docs-behavior-file behavior/my-pattern.feature |
discovered-gap
Section titled “discovered-gap”| Property | Value |
|---|---|
| Format | value |
| Purpose | Gap identified during session retrospective |
| Required | No |
| Repeatable | Yes |
| Example | @libar-docs-discovered-gap missing-error-handling |
discovered-improvement
Section titled “discovered-improvement”| Property | Value |
|---|---|
| Format | value |
| Purpose | Improvement identified during session retrospective |
| Required | No |
| Repeatable | Yes |
| Example | @libar-docs-discovered-improvement cache-invalidation |
discovered-risk
Section titled “discovered-risk”| Property | Value |
|---|---|
| Format | value |
| Purpose | Risk identified during session retrospective |
| Required | No |
| Repeatable | Yes |
| Example | @libar-docs-discovered-risk data-loss-on-migration |
discovered-learning
Section titled “discovered-learning”| Property | Value |
|---|---|
| Format | value |
| Purpose | Learning captured during session retrospective |
| Required | No |
| Repeatable | Yes |
| Example | @libar-docs-discovered-learning convex-mutation-limits |
see-also
Section titled “see-also”| Property | Value |
|---|---|
| Format | csv |
| Purpose | Related patterns for cross-reference without dependency implication |
| Required | No |
| Repeatable | No |
| Example | @libar-docs-see-also AgentAsBoundedContext, CrossContextIntegration |
api-ref
Section titled “api-ref”| Property | Value |
|---|---|
| Format | csv |
| Purpose | File paths to implementation APIs (replaces ‘See:’ Markdown text in Rules) |
| Required | No |
| Repeatable | No |
| Example | @libar-docs-api-ref @libar-dev/platform-core/src/durability/outbox.ts |
extract-shapes
Section titled “extract-shapes”| Property | Value |
|---|---|
| Format | csv |
| Purpose | TypeScript type names to extract from this file for documentation |
| Required | No |
| Repeatable | No |
| Example | @libar-docs-extract-shapes DeciderInput, ValidationResult, ProcessViolation |
| Property | Value |
|---|---|
| Format | value |
| Purpose | Marks declaration as documentable shape, optionally with group name |
| Required | No |
| Repeatable | No |
| Example | @libar-docs-shape api-types |
arch-role
Section titled “arch-role”| Property | Value |
|---|---|
| Format | enum |
| Purpose | Architectural role for diagram generation (component type) |
| Required | No |
| Repeatable | No |
| Valid Values | bounded-context, command-handler, projection, saga, process-manager, infrastructure, repository, decider, read-model, service |
| Example | @libar-docs-arch-role projection |
arch-context
Section titled “arch-context”| Property | Value |
|---|---|
| Format | value |
| Purpose | Bounded context this component belongs to (for subgraph grouping) |
| Required | No |
| Repeatable | No |
| Example | @libar-docs-arch-context orders |
arch-layer
Section titled “arch-layer”| Property | Value |
|---|---|
| Format | enum |
| Purpose | Architectural layer for layered diagrams |
| Required | No |
| Repeatable | No |
| Valid Values | domain, application, infrastructure |
| Example | @libar-docs-arch-layer application |
include
Section titled “include”| Property | Value |
|---|---|
| Format | csv |
| Purpose | Cross-cutting document inclusion for content routing and diagram scoping |
| Required | No |
| Repeatable | No |
| Example | @libar-docs-include reference-sample,codec-system |
target
Section titled “target”| Property | Value |
|---|---|
| Format | value |
| Purpose | Target implementation path for stub files |
| Required | No |
| Repeatable | No |
| Example | @libar-docs-target src/api/stub-resolver.ts |
| Property | Value |
|---|---|
| Format | value |
| Purpose | Design session that created this pattern |
| Required | No |
| Repeatable | No |
| Example | @libar-docs-since DS-A |
convention
Section titled “convention”| Property | Value |
|---|---|
| Format | csv |
| Purpose | Convention domains for reference document generation from decision records |
| Required | No |
| Repeatable | No |
| Valid Values | testing-policy, fsm-rules, cli-patterns, output-format, pattern-naming, session-workflow, config-presets, annotation-system, pipeline-architecture, publishing, doc-generation, taxonomy-rules |
| Example | @libar-docs-convention fsm-rules, testing-policy |