Requirements Author
MicrosoftOfficialPublished by Microsoft
- Skill
- Guidelines
- Business and productivity
- CC-BY-4.0
- No issues found
AutoGineer summary
Written by AutoGineer from the skill’s own files, not by the author
The Requirements Author skill provides a structured methodology for managing the lifecycle of Business Requirements Documents (BRD) and Product Requirements Documents (PRD). It defines clear phases for discovery, definition, and governance, ensuring that requirements are testable, traceable, and ready for downstream implementation. The skill includes canonical templates, quality rubrics, and standardized handoff contracts to ensure consistency across project stages and agent sessions.
What it does
- Provides canonical templates for BRD and PRD documentation.
- Defines a multi-phase lifecycle for requirements from discovery to governance.
- Establishes strict quality rubrics and atomicity checklists for acceptance criteria.
- Manages traceability between business goals, functional requirements, and acceptance criteria.
- Standardizes handoff payloads between BRD and PRD phases.
- Maintains version lineage and governance records for approved requirements.
When to use it
- When initiating a new project requiring formal business or product requirements.
- When transitioning from business-level objectives to product-level specifications.
- When you need to ensure requirements are testable, unambiguous, and traceable.
- When establishing a governance process for document approval and version control.
Advantages
- Ensures consistency in documentation structure and naming conventions.
- Reduces ambiguity through rigorous atomicity and quality checks.
- Facilitates seamless handoffs between business and product teams.
- Provides clear audit trails through version lineage and governance logs.
Usage examples
- “Initialize a new BRD for the upcoming project using the canonical template.”
- The agent sets up the BRD structure, applying the required frontmatter and initializing the Discover phase.
- “Validate the current set of acceptance criteria for the PRD.”
- The agent applies the atomicity checklist to ensure each criterion is testable, atomic, and follows the defined quality rubric.
Install
Download the skill as a ZIP:
https://mp-staging.autogineer.com/agent-skills/microsoft/requirements-author/downloadUnzip it into the cross-client skills folder of your project:
mkdir -p .agents/skills && unzip requirements-author.zip -d .agents/skills
Documentation by Microsoft
Requirements Author Skill
Overview
This skill defines how to produce and evolve requirements documents across the project lifecycle for two document types: the Business Requirements Document (BRD) and the Product Requirements Document (PRD). Shared requirements-engineering knowledge lives in references/_shared/, while BRD-specific and PRD-specific knowledge live in references/brd/ and references/prd/ so each consuming agent loads only what its document needs.
The canonical BRD template is brd-full.md with its brd-frontmatter-overlay.md, and the canonical PRD template is prd-full.md. The BRD Builder dispatches into the BRD phase anchors (#discover, #define, #govern); the PRD Builder dispatches into the PRD phase anchors (#prd-assess through #prd-finalize).
Use this skill with the references for the active document scope:
Shared (references/_shared/):
BRD scope (references/brd/):
PRD scope (references/prd/):
Handoff Transport Convention
The producing workflow owns each handoff's canonical transport, and the
consumer validates the complete payload regardless of transport. An outcome
hypothesis returns OUTCOME_HYPOTHESIS_TO_BRD_HANDOFF_V1 inline by default
because it is a one-time seed derived from an already persisted source
artifact; the user may instead supply a separately persisted payload path.
BRD Govern persists BRD_TO_PRD_HANDOFF_V1 and returns its path because that
payload is a durable governance record consumed across agent sessions. This
asymmetry is intentional and does not change payload authority or validation.
BRD Lifecycle
| Phase | Primary objective | Entry condition | Exit condition |
|---|---|---|---|
| Discover | Establish business context, stakeholder scope, and problem framing | Request or initiative is in intake | Discover hard gate passes and artifacts are complete |
| Define | Produce complete, testable, and traceable requirements content | Discover artifacts are approved for elaboration | Define hard gate passes with quality evidence |
| Govern | Finalize, approve, and supersede BRD versions under lineage controls | Define package is approved for governance review | Govern hard gate passes and publication artifacts are recorded |
Discover {#discover}
Activities
Capture business context, drivers, imposed constraints, and expected outcomes.
Identify stakeholders, decision owners, and review participants.
Define scope boundaries, assumptions, and dependency surfaces.
Draft initial requirement candidates and map early traceability placeholders.
Validate and disposition an
OUTCOME_HYPOTHESIS_TO_BRD_HANDOFF_V1payload when one is supplied.
Outcome hypothesis intake
Use Outcome Hypothesis-to-BRD Handoff as the canonical contract.
Accept the YAML inline or from a user-supplied artifact path.
Validate the complete payload before copying any value into the BRD.
Reject unsupported versions, incomplete seeds, placeholder values, and invalid provenance. Do not reinterpret a rejected payload as unstructured evidence.
Assign the next stable
BG-###identifier.Record distinct statement, KPI, baseline, target, timeframe, measurement source, and owner values.
Mark each seed field
acceptedorrevised. For a revision, preserve the source value, current BRD value, and rationale.Map assumptions and open questions into their canonical BRD sections. Initialize each imported question to
Openunless Discover explicitly confirms another BRD-owned status. Every deferred question requires a rationale for deferral and one target phase:PRD,Implementation,Operations, orFuture-Release.Record the handoff ID, source path, source SHA-256, and KPI measurement source in the BRD provenance receipt.
Before Discover accepts the handoff, the validated payload is authoritative for imported seed values. Discover may explicitly accept or revise those values. After Discover exits, the BRD is authoritative. A later hypothesis change requires a new validated payload and explicit Discover re-entry.
Hard exit gate
Discover exits only when:
Scope is bounded and stakeholder ownership is explicit.
Core assumptions and constraints are documented and reviewable.
Seed artifacts needed for Define are present and internally consistent.
Any outcome-hypothesis handoff has passed validation, every imported seed field has an explicit disposition, and its provenance receipt is complete.
Output artifacts
Discover summary and scope statement.
Stakeholder inventory with role and ownership mapping.
Initial assumption and constraint register.
Seed requirement and traceability scaffold for Define.
Outcome-hypothesis receipt and field dispositions when a handoff was supplied.
Define {#define}
Activities
Author full BRD content using brd-full.md and the canonical naming rules.
Refine business goals and requirement sets with clear acceptance intent.
Build and verify author-maintained traceability links across FR, AC, BG, and BR records.
Perform quality assessment using the BRD quality reporting contract.
Hard exit gate
Define exits only when:
Requirement content is complete, unambiguous, and testable.
Traceability links satisfy the active ID schema and naming policy.
FR-to-AC coverage meets the active
fr_to_ac_coverage_threshold_pctor has a recorded blocker.Quality findings are generated and reviewed against the defined rubric.
Output artifacts
Full BRD draft package with structured sections.
Author-maintained traceability matrix aligned to naming and ID conventions.
BRD quality findings and consolidated quality report payloads.
Define gate decision record with reviewer notes.
Govern {#govern}
Activities
Prepare final BRD for approval with version metadata and lineage fields.
Bump approved BRDs from draft
0.x.yversions to1.0.0or higher.Resolve or disposition remaining quality findings.
Publish approved BRD outputs and downstream handoff payloads.
Maintain supersession chain when issuing replacement BRD versions.
Govern handoff production
Before emitting BRD_TO_PRD_HANDOFF_V1, the BRD Builder applies the coverage and waiver validation rules in BRD-to-PRD Handoff, including zero-FR coverage handling. It records the following values from the signed-off BRD and final quality review:
A lowercase SHA-256 hash of the exact BRD artifact bytes at signoff.
Counts for FR, NFR, BR, CON, AC, and BG identifiers using id-schema.md.
FR-to-AC and FR-to-BG coverage metrics from the author-maintained traceability matrix.
The final
BRD_QUALITY_REPORT_V1reference, overall status, and Govern decision.Signoff approvers, roles, decisions, approval timestamps, comments, and active waivers.
Waiver records for any accepted FR-to-AC threshold gap or FR-to-BG target gap.
After validation succeeds, write the complete YAML payload to .copilot-tracking/brd-sessions/<brd-name>.handoff.yml, record that path in BRD session state, and return the path with a compact Govern summary. Do not rely on an inline chat payload as the downstream transport.
Hard exit gate
Govern exits only when:
Approval status and required reviewers are recorded.
Version and lineage metadata are valid and complete.
The final quality report authorizes Govern exit.
Handoff artifacts are published for downstream consumers.
Output artifacts
Approved BRD release artifact.
BRD-to-PRD handoff payload.
Governance decision log with approval evidence.
Supersession linkage record for replaced BRD versions.
Status taxonomy
Use the following status values for BRD lifecycle tracking:
draft: Actively authored or revised.in-review: Under formal review and gate validation.approved: Accepted for governed use.superseded: Replaced by a newer approved BRD.
Quality rubric pointer
Apply the BRD quality rubric and payload contracts from BRD Quality Formats together with guidance in Requirements Definition. Treat rubric results as gate evidence for Define and Govern decisions. The BRD Quality Reviewer emits both standard findings and the consolidated quality report.
Supersession lineage rules
A BRD can supersede one or more earlier BRDs when scope is merged.
A BRD can be superseded by only one approved successor version.
Every supersession event records
supersedesandsuperseded_bylinks.Supersession preserves historical artifacts for auditability.
PRD Lifecycle
The PRD Builder agent runs a seven-phase lifecycle. Each phase has its own section anchor below so the agent loads only the guidance for the active phase.
| Phase | Section anchor | Primary objective |
|---|---|---|
| Assess | #prd-assess | Determine whether enough context exists to create PRD files. |
| Discover | #prd-discover | Establish the PRD title, scope, and product goals. |
| Create | #prd-create | Generate the PRD file and state file once context is clear. |
| Build | #prd-build | Gather detailed requirements iteratively. |
| Integrate | #prd-integrate | Incorporate references, documents, and external materials. |
| Validate | #prd-validate | Ensure completeness and quality before approval. |
| Finalize | #prd-finalize | Deliver the complete, actionable PRD. |
PRD Assess {#prd-assess}
Activities
Determine whether enough product context exists to create PRD artifacts.
Identify the initiative, problem statement, and primary target users.
Check for an upstream
BRD_TO_PRD_HANDOFF_V1artifact path and ingest its coverage and waiver context when present.Check for an upstream feasibility-to-PRD handoff. Follow Feasibility-to-PRD Handoff to recognize it by
kind, verify required metadata, verdict field presence, and a readable workspace-relative study path. Treat feasibility as supplementary evidence and preserve approved BRD scope.For a new session, carry the handoff kind, path, ingest timestamp, verdict, and study revision identifier in the Assess output until Create writes the state file. When state already exists, update its feasibility-specific metadata object directly. Keep raw candidate content in the handoff artifact.
Decide whether to gather more context or proceed to file creation.
Hard exit gate
Assess exits only when:
A meaningful kebab-case PRD name can be derived.
Problem framing and primary users are identified.
Any available BRD handoff artifact has been read, its payload validated, and its coverage metrics recorded.
Any available feasibility handoff is recognized by
kind, has readable workspace-relative paths, a valid verdict shape, and normalized metadata ready for Create or persisted in existing state.
Output artifacts
Assess summary noting context sufficiency.
Derived working title for the PRD.
Ingested handoff context when a BRD handoff payload exists.
Feasibility verdict, evidence summary, constraints, gaps, and normalized handoff metadata when a feasibility handoff exists. Negative verdicts create no candidate dispositions.
PRD Discover {#prd-discover}
Activities
Ask focused questions to establish the PRD title, scope, and product goals.
Explore the problem space using Product Discovery and MVP Framing.
Capture target users, candidate success metrics, and explicit non-goals using Metrics Frameworks.
Hard exit gate
Discover exits only when:
Title and scope are explicit.
Primary users and candidate success metrics are named.
In-scope and out-of-scope boundaries are recorded.
Output artifacts
Discovery summary.
Scope and non-goals statement.
Candidate success metrics.
PRD Create {#prd-create}
Activities
Generate the PRD file from prd-full.md and create the session state file once title and context are clear.
Populate the skeleton with the established scope, users, and goals.
Seed the iterative requirement and metric structure for Build.
When Assess produced normalized feasibility metadata, write its fields atomically to the new state file as
feasibilityHandoff, carryingkind,path,ingestedAt,verdict, andstudyRevisionId. State written before this contract may carryschemaVersioninstead ofkind; read it without error and rewrite the object to the current shape on the next feasibility metadata update. Do not persist raw candidate content.
Hard exit gate
Create exits only when:
The PRD file and state file exist.
The skeleton matches the canonical PRD structure.
Initial scope and goals are seeded.
Any normalized feasibility metadata from Assess is present in the newly created state before Build begins.
Output artifacts
PRD draft skeleton.
PRD session state file.
Seeded scope and goals sections.
Feasibility handoff metadata persisted when supplied.
PRD Build {#prd-build}
Activities
Gather detailed functional and non-functional requirements iteratively.
When
feasibilityHandoffis present, read candidate content from its workspace-relative path. Stop if ingestion was reported but metadata is absent or the path is unreadable.Give every forward-verdict feasibility candidate exactly one PRD-owned disposition:
accepted-fr,accepted-nfr,accepted-constraint,retained-gap,rejected, ordeferred. Treat concern hints as advisory evidence only.Allocate final
FR-###,NFR-###, orCON-###identifiers only after authoring and accepting the PRD statement. Preserve source handoff ID, source candidate ID, evidence references, disposition, rationale, and resulting PRD ID in the Feasibility Candidate Disposition register.Preserve signed-off BRD authority. Record and explicitly resolve BRD and feasibility conflicts, or retain them as Build gaps when current evidence cannot support a responsible resolution.
Author acceptance criteria using EARS Acceptance and the Connextra Template.
Classify non-functional requirements with the NIST 800-160 NFR taxonomy and check stories against INVEST.
Maintain author traceability across requirements, goals, and metrics using Traceability Naming, Traceability Matrix, and id-schema.md.
Hard exit gate
Build exits only when:
Requirements are complete, testable, and traceable.
Acceptance criteria follow EARS or Given-When-Then form.
Non-functional requirements are categorized.
Coverage meets the active thresholds or records a blocker.
Every forward-verdict feasibility candidate has exactly one disposition row, every accepted row names its final PRD ID, and negative verdicts have no candidate rows.
Output artifacts
Full PRD requirement set.
Author-maintained traceability matrix.
Acceptance criteria and NFR classifications.
Feasibility Candidate Disposition register when a forward feasibility handoff exists.
PRD Integrate {#prd-integrate}
Activities
Incorporate user-provided references, documents, and external materials.
Reconcile incoming content with existing requirements and resolve conflicts.
Link supporting evidence to requirements and metrics.
Hard exit gate
Integrate exits only when:
Provided references are incorporated or explicitly deferred.
Conflicts between sources are resolved.
Supporting evidence is linked.
Output artifacts
Updated PRD sections with integrated references.
Reference and evidence linkage record.
PRD Validate {#prd-validate}
Activities
Assess completeness and quality before approval.
Run the PRD Quality Reviewer to emit
PRD_STANDARD_FINDINGS_V1andPRD_QUALITY_REPORT_V1per PRD Quality Formats.Review findings against the rubric and resolve or disposition gaps.
Hard exit gate
Validate exits only when:
Quality findings and the consolidated report are generated.
The report authorizes Validate exit via
gate_decisions.validate_exit.Coverage and quality thresholds are met or waived.
Output artifacts
PRD quality findings and report payloads.
Validate gate decision record.
PRD Finalize {#prd-finalize}
Activities
Deliver the complete, actionable PRD.
Resolve remaining findings and record version and approval metadata.
Run a Finalize drift check and publish downstream artifacts.
Hard exit gate
Finalize exits only when:
Approval status and required reviewers are recorded.
The final quality report authorizes Finalize exit via
gate_decisions.finalize_exit.No unresolved blocking findings remain.
Output artifacts
Approved PRD release artifact.
Finalize decision log with approval evidence.
References
The skill bundles reference documents under references/, organized into three scopes: shared requirements-engineering knowledge in references/_shared/, BRD-specific knowledge in references/brd/, and PRD-specific knowledge in references/prd/. Load a reference body only when its phase activity requires it; each body links to its own sub-references (standards pointers, scoring sheets, and worked examples).
Shared references (references/_shared/)
requirements-definition.md - Requirement categories, canonical statement form, acceptance-criteria formats, and quality dimensions.
stakeholder-analysis.md - Mendelow Power/Interest grid and RACI accountability variants.
process-modeling.md - Optional process, decision, and structural diagram guidance.
prioritization-schemes.md - Required MoSCoW prioritization scheme.
traceability-naming.md - Requirement, goal, and decision identifier routing plus traceability conventions.
id-schema.md - Canonical prefix, digit, and adjacent identifier rules.
traceability-matrix.md - Author-maintained FR-to-AC, FR-to-BG, and BR-to-FR matrix views.
design-decisions.md - Registry for
DD-###design decision codes.quality-rubric.md - Operational status taxonomy (
RISK/CAUTION/COVERED/NOT_APPLICABLE) and the gate decision rule.standards-excerpts.md - Cite-only registry of third-party standards (ISO, IIBA, PMI, ISTQB) referenced by name.
BRD references (references/brd/)
brd-quality-formats.md - Producer and consumer map for the BRD data contracts.
requirements-quality-rubric.md - Combined per-requirement, per-NFR-category, and per-business-goal scoring sheets.
handoff-payload-schema.md - BRD-author view of the BRD-to-PRD handoff payload.
PRD references (references/prd/)
product-discovery.md - Problem-space exploration and discovery questioning for PRD scope.
mvp-framing.md - MVP framing and scope-boundary guidance.
metrics-frameworks.md - JTBD, HEART, and AARRR success-metric frameworks.
ears-acceptance.md - EARS acceptance-criteria patterns for PRD requirements.
nist-800-160-nfr.md - NIST 800-160 non-functional requirement taxonomy.
invest.md - INVEST quality criteria for user stories.
connextra-template.md - Connextra user-story template.
prd-quality-formats.md - Producer and consumer map for the PRD data contracts.
feasibility-to-prd-handoff.md - Consumer rules for feasibility Assess ingestion, Create persistence, Build disposition, BRD coexistence, and source traceability.
Templates
Templates under templates/ are selected by the document frontmatter and canonical document shape.
brd-full.md - Canonical BRD template covering every section from Executive Summary through Sign-Off.
brd-frontmatter-overlay.md - Schema for BRD YAML frontmatter, including
diagram_format, lineage, coverage thresholds, and requirement-prefix overrides.diagram-mermaid.md - Mermaid flowchart fragment; the default diagram format.
diagram-ascii.md - ASCII process-diagram fragment for low-fidelity Discover-phase sketches.
prd-full.md - Canonical PRD template covering every section from product overview through acceptance and metrics.
Data Contracts
Payload contracts govern quality assessment and downstream handoff for each document type. The quality and BRD handoff payloads carry a fixed schema_version; consumers fail fast on any other value, so those constants MUST NOT change. The feasibility-to-PRD handoff instead carries a plain kind marker, because its producer and consumer ship together and no version negotiation applies.
BRD data contracts:
| Contract | schema_version | Reference |
|---|---|---|
| Standard findings | BRD_STANDARD_FINDINGS_V1 | brd-standard-findings-v1.md |
| Quality report | BRD_QUALITY_REPORT_V1 | brd-quality-report-v1.md |
| BRD-to-PRD handoff | BRD_TO_PRD_HANDOFF_V1 | brd-to-prd-handoff-v1.md |
PRD data contracts:
| Contract | schema_version | Reference |
|---|---|---|
| Standard findings | PRD_STANDARD_FINDINGS_V1 | prd-standard-findings-v1.md |
| Quality report | PRD_QUALITY_REPORT_V1 | prd-quality-report-v1.md |
Upstream PRD input contracts:
| Contract | Identifier | Reference |
|---|---|---|
| BRD-to-PRD handoff | schema_version: BRD_TO_PRD_HANDOFF_V1 | brd-to-prd-handoff-v1.md |
| Feasibility-to-PRD handoff | kind: feasibility-to-prd-handoff | feasibility-to-prd-handoff.md |
The PRD lifecycle consumes both upstream contracts during Assess. BRD input supplies approved business context, coverage, and waivers. Feasibility input supplies a confirmed verdict, evidence, constraints, gaps, and candidate proposals for PRD Build. Neither contract bypasses PRD authoring.
Mandatory Load Directives
The BRD Builder and PRD Builder agents each enforce a phase → section load contract. Each phase MUST load its section of this skill before executing phase work, and MUST append the section anchor to state.phaseSkillsLoaded.
BRD Builder directives:
| Phase | Section anchor | Required phaseSkillsLoaded entry |
|---|---|---|
| Discover | #discover | brd-author#discover |
| Define | #define | brd-author#define |
| Govern | #govern | brd-author#govern |
PRD Builder directives:
| Phase | Section anchor | Required phaseSkillsLoaded entry |
|---|---|---|
| Assess | #prd-assess | prd-author#assess |
| Discover | #prd-discover | prd-author#discover |
| Create | #prd-create | prd-author#create |
| Build | #prd-build | prd-author#build |
| Integrate | #prd-integrate | prd-author#integrate |
| Validate | #prd-validate | prd-author#validate |
| Finalize | #prd-finalize | prd-author#finalize |
The agent reads sections of this skill file and records the entry in state.phaseSkillsLoaded before any phase work executes. phaseSkillsLoaded is durable load history, not proof that the guidance is present in the current model context. Within one live context, re-entering a phase whose section was already read does not require reloading. After a cold start, resume, or context summarization, the agent reloads the current phase section even when its entry is recorded.
Source Attribution
The bundled reference bodies cite third-party standards and frameworks by name and clause only; no upstream prose is reproduced or paraphrased. Where a reference names a standard's characteristics or categories, the accompanying review criteria, anchors, and indicators are original Microsoft content under CC BY 4.0, not reproductions of the standard's definitions; the authoritative definitions live in the cited standards. The cite-only registry in standards-excerpts.md is the single place new standards citations are added. Standards referenced by name include ISO/IEC/IEEE 29148:2018, ISO/IEC 25010:2023, IIBA BABOK v3, PMI Business Analysis for Practitioners, the ISTQB Glossary, OMG BPMN / DMN / UML, the Cucumber Gherkin pattern, and MoSCoW prioritization, each the property of its respective rights holder.
License
This skill is original Microsoft content licensed under CC BY 4.0.
Files
- ATTRIBUTION.mdAdded by AutoGineer981 B
- LICENSEAdded by AutoGineer16.6 KiB
- SKILL.md28.0 KiB
- references/_shared/atomicity-checklist.md5.8 KiB
- references/_shared/design-decisions.md2.0 KiB
- references/_shared/diagram-format-selector.md5.5 KiB
- references/_shared/given-when-then.md5.5 KiB
- references/_shared/id-schema.md6.9 KiB
- references/_shared/iso-29148-quality-attrs.md4.7 KiB
- references/_shared/mendelow-matrix.md5.3 KiB
- references/_shared/moscow.md3.6 KiB
- references/_shared/prioritization-schemes.md6.8 KiB
- references/_shared/process-modeling.md6.0 KiB
- references/_shared/quality-rubric.md5.4 KiB
- references/_shared/raci-patterns.md7.7 KiB
- references/_shared/requirements-definition.md13.2 KiB
- references/_shared/rpi-research-integration.md14.7 KiB
- references/_shared/smart-rubric.md5.6 KiB
- references/_shared/stakeholder-analysis.md7.9 KiB
- references/_shared/standards-excerpts.md11.9 KiB
- references/_shared/traceability-matrix.md5.2 KiB
- references/_shared/traceability-naming.md6.1 KiB
- references/brd/brd-quality-formats.md4.5 KiB
- references/brd/brd-quality-report-v1.md16.8 KiB
- references/brd/brd-standard-findings-v1.md13.5 KiB
- references/brd/brd-to-prd-handoff-v1.md12.6 KiB
- references/brd/handoff-payload-schema.md8.2 KiB
- references/brd/iso-25010-nfr-taxonomy.md5.5 KiB
- references/brd/iso-29148-quality-gate.md8.6 KiB
- references/brd/istqb-testability.md5.3 KiB
- references/brd/outcome-hypothesis-to-brd-handoff-v1.md11.7 KiB
- references/brd/requirements-quality-rubric.md14.0 KiB
- references/prd/connextra-template.md4.4 KiB
- references/prd/ears-acceptance.md4.9 KiB
- references/prd/feasibility-to-prd-handoff.md4.4 KiB
- references/prd/invest.md4.1 KiB
- references/prd/metrics-frameworks.md4.3 KiB
- references/prd/mvp-framing.md3.6 KiB
- references/prd/nist-800-160-nfr.md6.5 KiB
- references/prd/prd-quality-formats.md4.4 KiB
- references/prd/prd-quality-report-v1.md17.6 KiB
- references/prd/prd-standard-findings-v1.md14.6 KiB
- references/prd/product-discovery.md7.1 KiB
- templates/brd/brd-frontmatter-overlay.md7.5 KiB
- templates/brd/brd-full.md13.6 KiB
- templates/brd/diagram-ascii.md2.3 KiB
- templates/brd/diagram-mermaid.md989 B
- templates/prd/prd-full.md13.5 KiB
references/brd/brd-standard-findings-v1.md
description: 'BRD_STANDARD_FINDINGS_V1 schema - detailed findings output emitted by BRD Quality Reviewer with ISO 29148, ISO 25010, SMART, and coverage evidence'
BRD Standard Findings — BRD_STANDARD_FINDINGS_V1
This document defines the BRD_STANDARD_FINDINGS_V1 payload emitted by the BRD Quality Reviewer subagent (brd-quality-reviewer). One payload is produced in the same invocation as the paired BRD_QUALITY_REPORT_V1 payload.
Purpose
The payload captures structured issue details for one BRD quality review. Findings carry status, severity, location, optional requirement identifiers, observations, and recommendations. Findings MUST NOT carry gate decisions; the paired BRD_QUALITY_REPORT_V1 payload owns Define-exit and Govern-exit decisions.
Format
The payload is YAML. Top-level fields are unordered; producers SHOULD emit fields in the order documented below for human readability. Consumers MUST tolerate any field order.
schema_version: BRD_STANDARD_FINDINGS_V1
assessment_id: <ASSESSMENT_ID>
assessed_at: <ISO_8601_TIMESTAMP>
brd:
id: <BRD_ID>
version: <BRD_VERSION>
phase: <BRD_PHASE>
partition_id: <PARTITION_ID>
artifact_path: <BRD_ARTIFACT_PATH>
standard:
skill_name: <STANDARD_SKILL_NAME>
skill_version: <STANDARD_SKILL_VERSION>
mode: plan
assessment_outcome: <ASSESSMENT_OUTCOME>
overall_status: <OVERALL_STATUS>
summary_counts:
RISK: <RISK_COUNT>
CAUTION: <CAUTION_COUNT>
COVERED: <COVERED_COUNT>
NOT_APPLICABLE: <NA_COUNT>
findings:
- finding_id: <FINDING_ID>
checklist_item: <CHECKLIST_ITEM_ID>
requirement_id: <REQUIREMENT_ID>
status: <FINDING_STATUS>
severity: <FINDING_SEVERITY>
location:
section: <BRD_SECTION>
line_range: <LINE_RANGE>
finding: <FINDING_DESCRIPTION>
recommendation: <RECOMMENDATION>
iso_29148_attributes:
necessary: <ATTRIBUTE_SCORE>
appropriate: <ATTRIBUTE_SCORE>
unambiguous: <ATTRIBUTE_SCORE>
complete: <ATTRIBUTE_SCORE>
singular: <ATTRIBUTE_SCORE>
feasible: <ATTRIBUTE_SCORE>
verifiable: <ATTRIBUTE_SCORE>
correct: <ATTRIBUTE_SCORE>
conforming: <ATTRIBUTE_SCORE>
iso_25010_categories:
functional_suitability: <PRESENCE_BOOLEAN>
performance_efficiency: <PRESENCE_BOOLEAN>
compatibility: <PRESENCE_BOOLEAN>
usability: <PRESENCE_BOOLEAN>
reliability: <PRESENCE_BOOLEAN>
security: <PRESENCE_BOOLEAN>
maintainability: <PRESENCE_BOOLEAN>
portability: <PRESENCE_BOOLEAN>
smart_business_goals:
- goal_id: <BUSINESS_GOAL_ID>
statement: <BUSINESS_GOAL_STATEMENT>
specific: <SMART_BOOLEAN>
measurable: <SMART_BOOLEAN>
achievable: <SMART_BOOLEAN>
relevant: <SMART_BOOLEAN>
time_bound: <SMART_BOOLEAN>
overall: <SMART_PASS_FAIL>
fr_ac_coverage:
fr_total: <FR_TOTAL>
fr_with_ac: <FR_WITH_AC>
coverage_pct: <COVERAGE_PCT>
notes: <REVIEWER_NOTES>Field definitions
Top-level metadata
schema_version(string, required) — MUST be the literal stringBRD_STANDARD_FINDINGS_V1. Consumers fail fast on any other value.assessment_id(string, required) — Unique identifier for this assessment run. Recommended form:<standard_skill_name>-<brd_id>-<ISO_8601_basic_timestamp>.assessed_at(string, required) — ISO 8601 timestamp (UTC) when the assessment completed.mode(string, required) — MUST be the literal stringplan. TheBRD Quality Revieweroperates in plan mode;auditanddiffare reserved for future scenarios.assessment_outcome(string, optional) — One ofplan,drift. Omit or set toplanfor ordinary Define-exit or on-request reviews. Set todriftwhen Govern drift detection finds a regression from the last passing review.
brd (object, required)
id(string, required) — Stable BRD identifier (for exampleBRD-2026-018).version(string, required) — Semantic version of the BRD draft assessed (for example0.3.1). Drafts use0.x.y; signed-off BRDs use1.x.y.phase(string, required) — One ofDiscover,Define,Govern. Matches the BRD Builder lifecycle phase active when the assessment ran.partition_id(string, optional) — Identifier of the BRD partition assessed when the BRD is partitioned. Omit when the assessment covers the full BRD.artifact_path(string, required) — Workspace-relative path to the BRD artifact.
standard (object, required)
skill_name(string, required) — Name of the standard skill bundle that supplied the rubric (for examplerequirements-quality).skill_version(string, required) —spec_versionvalue from the standard skill'sSKILL.mdfrontmatter.
overall_status (string, required)
One of:
RISK— At least one finding has statusRISK. Define-exit gate blocked.CAUTION— NoRISKfindings; one or moreCAUTIONfindings. Soft-block; surface in coaching.COVERED— All applicable checklist items satisfied; noRISKorCAUTIONfindings.NOT_APPLICABLE— The standard is not applicable to this BRD partition; no findings emitted other thanNOT_APPLICABLErows.
summary_counts (object, required)
Integer counts of findings by status. Sum MUST equal the length of the findings array.
RISK(integer, required, ≥ 0).CAUTION(integer, required, ≥ 0).COVERED(integer, required, ≥ 0).NOT_APPLICABLE(integer, required, ≥ 0).
findings (array, required)
Zero or more finding objects, one per checklist item evaluated. Each item:
finding_id(string, required) — Unique within the payload. Recommended form:<standard_skill_name>-<sequence>(for examplereq-eng-001).checklist_item(string, required) — Identifier of the rubric checklist item from the standard skill (for exampleiso-29148-singular).requirement_id(string, optional) — Requirement, business goal, acceptance criterion, or decision identifier the finding evaluates. Use canonical three-or-more-digit identifiers such asFR-001,AC-001,NFR-001,CON-001,BR-001,BG-001, orDD-001when the finding maps to one item.status(string, required) — One ofRISK,CAUTION,COVERED,NOT_APPLICABLE.severity(string, required) — One ofCRITICAL,HIGH,MEDIUM,LOW,N/A.N/AMUST be used whenstatusisCOVEREDorNOT_APPLICABLE.location(object, required) — Pointer into the BRD artifact.section(string, required) — Section identifier or heading text (for example3.2 Functional Requirements).line_range(string, optional) — Line range in the BRD artifact (for exampleL142-L158). Omit when the finding spans the whole section.
finding(string, required) — Narrative description of what the reviewer observed. One to three sentences.recommendation(string, required) — Concrete next action for the author.nullis permitted only whenstatusisCOVEREDorNOT_APPLICABLE.
iso_29148_attributes (object, conditional)
Required when standard.skill_name is requirements-quality; otherwise optional.
Score (integer, 0–3 inclusive) per ISO/IEC/IEEE 29148 individual-requirement attribute. Scoring anchors are defined in the requirements-definition skill's rubric reference.
Required keys when present: necessary, appropriate, unambiguous, complete, singular, feasible, verifiable, correct, conforming.
iso_25010_categories (object, conditional)
Required when standard.skill_name is requirements-quality; otherwise optional.
Boolean per ISO/IEC 25010 quality characteristic indicating whether the BRD partition addresses at least one NFR in that category. Per DD-012, missing categories surface as a qualitative flag and do not require an N/A justification.
Required keys when present: functional_suitability, performance_efficiency, compatibility, usability, reliability, security, maintainability, portability.
smart_business_goals (array, conditional)
Required when standard.skill_name is requirements-quality; otherwise optional.
Zero or more goal objects. Per DD-008, every business goal in the BRD must be SMART by Govern exit.
goal_id(string, required) — Identifier of the business goal in the BRD (for exampleBG-001).statement(string, required) — Verbatim goal statement from the BRD.specific,measurable,achievable,relevant,time_bound(boolean, required) — Per-attribute pass/fail.overall(string, required) —PASSwhen all five attributes aretrue;FAILotherwise.
fr_ac_coverage (object, conditional)
Required when standard.skill_name is requirements-quality; otherwise optional.
Coverage of functional requirements by acceptance criteria, per DD-009.
fr_total(integer, required, ≥ 0).fr_with_ac(integer, required, 0 ≤ value ≤fr_total).coverage_pct(number, required, 0.0–100.0) — Computed as100 * fr_with_ac / fr_totalwhenfr_total > 0;0.0whenfr_total == 0.
notes (string, optional)
Free-form reviewer commentary not tied to a specific finding (for example calibration notes, ambiguous edge cases observed during scoring).
Validation rules
schema_versionMUST equalBRD_STANDARD_FINDINGS_V1.overall_statusMUST be consistent withsummary_counts:RISKwhensummary_counts.RISK > 0.CAUTIONwhensummary_counts.RISK == 0andsummary_counts.CAUTION > 0.COVEREDwhensummary_counts.RISK == 0,summary_counts.CAUTION == 0, andsummary_counts.COVERED > 0.NOT_APPLICABLEwhensummary_counts.COVERED == 0,summary_counts.RISK == 0, andsummary_counts.CAUTION == 0.
Every
findings[].finding_idMUST be unique within the payload.Every
findings[].requirement_id, when present, MUST use the canonicalPREFIX-###form with at least three digits.Every
findings[].severityMUST beN/Awhenfindings[].statusisCOVEREDorNOT_APPLICABLE.Every
findings[].recommendationMUST be non-null whenfindings[].statusisRISKorCAUTION.iso_29148_attributes.*values MUST be integers in the closed interval[0, 3], and the object MUST includecorrectwhen present.smart_business_goals[].overallMUST bePASSif and only if all five SMART booleans aretrue.fr_ac_coverage.fr_with_acMUST be less than or equal tofr_ac_coverage.fr_total.assessed_atMUST be a valid ISO 8601 timestamp with timezone designator.The payload MUST NOT include
gate_decision,gate_decisions,define_exit, orgovern_exit; gate decisions belong toBRD_QUALITY_REPORT_V1.
Example payload
schema_version: BRD_STANDARD_FINDINGS_V1
assessment_id: requirements-quality-BRD-2026-018-20260508T140312Z
assessed_at: "2026-05-08T14:03:12Z"
brd:
id: BRD-2026-018
version: 0.3.1
phase: Define
partition_id: claims-intake
artifact_path: docs/brds/2026/brd-claims-intake.md
standard:
skill_name: requirements-quality
skill_version: "1.0"
mode: plan
assessment_outcome: plan
overall_status: RISK
summary_counts:
RISK: 2
CAUTION: 1
COVERED: 5
NOT_APPLICABLE: 0
findings:
- finding_id: req-qual-001
checklist_item: iso-29148-unambiguous
requirement_id: FR-001
status: RISK
severity: HIGH
location:
section: "3.2 Functional Requirements"
line_range: L142-L148
finding: FR-001 uses the unqualified term "quickly" without a measurable threshold, violating ISO 29148 unambiguity.
recommendation: Restate FR-001 with a quantitative latency target (for example "within 2 seconds of submission").
- finding_id: req-qual-002
checklist_item: smart-business-goal-measurable
requirement_id: BG-001
status: RISK
severity: HIGH
location:
section: "1.3 Business Goals"
line_range: L48-L52
finding: Business goal BG-001 has no measurable success metric and fails the SMART Measurable attribute.
recommendation: Add a numeric KPI to BG-001 (for example "reduce claim cycle time by 30%").
- finding_id: req-qual-003
checklist_item: iso-25010-security-coverage
requirement_id: NFR-001
status: CAUTION
severity: MEDIUM
location:
section: "4 Non-Functional Requirements"
finding: The Security category contains a single authentication NFR; no NFRs address confidentiality, integrity, or auditability.
recommendation: Add NFRs covering data confidentiality at rest and audit logging retention.
- finding_id: req-qual-004
checklist_item: iso-29148-singular
requirement_id: FR-002
status: COVERED
severity: N/A
location:
section: "3.2 Functional Requirements"
finding: All functional requirements are atomic; no compound statements detected.
recommendation: null
iso_29148_attributes:
necessary: 3
appropriate: 3
unambiguous: 1
complete: 2
singular: 3
feasible: 3
verifiable: 2
conforming: 3
iso_25010_categories:
functional_suitability: true
performance_efficiency: true
compatibility: false
usability: true
reliability: true
security: true
maintainability: false
portability: false
smart_business_goals:
- goal_id: BG-001
statement: Reduce average claim adjudication time by 30% within 12 months of launch.
specific: true
measurable: true
achievable: true
relevant: true
time_bound: true
overall: PASS
- goal_id: BG-002
statement: Improve customer satisfaction with the claims experience.
specific: false
measurable: false
achievable: true
relevant: true
time_bound: false
overall: FAIL
fr_ac_coverage:
fr_total: 24
fr_with_ac: 21
coverage_pct: 87.5
notes: Partition `claims-intake` reviewed in isolation; cross-partition NFRs (residency, retention) deferred to the BRD-level aggregate run.Requirements and compatibility
Written for: GitHub Copilot, Claude Code
Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta
“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.
Needs: Claude Code frontmatter
Security
No issues found by our static scan· No issues found
A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.
Attribution and licence
- Published by
- Microsoft
- Publisher
- Microsoft (Official)
- Source
- microsoft/hve-core · .github/skills/project-planning/requirements-author · commit f425e94
- Licence
- Creative Commons Attribution 4.0 International (redistribution allowed)
- LICENSE (written by AutoGineer)
- ATTRIBUTION.md (written by AutoGineer)
- Synced
AutoGineer is not affiliated with or endorsed by Microsoft.
Download ZIP
The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download requirements-author.zip