Generated banner for Requirements Author
Generated logo for Requirements Author

Requirements Author

MicrosoftOfficialPublished by Microsoft

  • Skill
  • Guidelines
  • Business and productivity
  • CC-BY-4.0
  • No issues found

From the author

Requirements authoring guide for BRD and PRD across Discover, Define, and Govern with canonical templates and handoff contracts
— the description by Microsoft

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

  1. Download the skill as a ZIP:

    https://mp-staging.autogineer.com/agent-skills/microsoft/requirements-author/download
  2. Unzip 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

PhasePrimary objectiveEntry conditionExit condition
DiscoverEstablish business context, stakeholder scope, and problem framingRequest or initiative is in intakeDiscover hard gate passes and artifacts are complete
DefineProduce complete, testable, and traceable requirements contentDiscover artifacts are approved for elaborationDefine hard gate passes with quality evidence
GovernFinalize, approve, and supersede BRD versions under lineage controlsDefine package is approved for governance reviewGovern 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_V1 payload when one is supplied.

Outcome hypothesis intake

Use Outcome Hypothesis-to-BRD Handoff as the canonical contract.

  1. Accept the YAML inline or from a user-supplied artifact path.

  2. Validate the complete payload before copying any value into the BRD.

  3. Reject unsupported versions, incomplete seeds, placeholder values, and invalid provenance. Do not reinterpret a rejected payload as unstructured evidence.

  4. Assign the next stable BG-### identifier.

  5. Record distinct statement, KPI, baseline, target, timeframe, measurement source, and owner values.

  6. Mark each seed field accepted or revised. For a revision, preserve the source value, current BRD value, and rationale.

  7. Map assumptions and open questions into their canonical BRD sections. Initialize each imported question to Open unless Discover explicitly confirms another BRD-owned status. Every deferred question requires a rationale for deferral and one target phase: PRD, Implementation, Operations, or Future-Release.

  8. 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_pct or 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.y versions to 1.0.0 or 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_V1 reference, 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 supersedes and superseded_by links.

  • 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.

PhaseSection anchorPrimary objective
Assess#prd-assessDetermine whether enough context exists to create PRD files.
Discover#prd-discoverEstablish the PRD title, scope, and product goals.
Create#prd-createGenerate the PRD file and state file once context is clear.
Build#prd-buildGather detailed requirements iteratively.
Integrate#prd-integrateIncorporate references, documents, and external materials.
Validate#prd-validateEnsure completeness and quality before approval.
Finalize#prd-finalizeDeliver 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_V1 artifact 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, carrying kind, path, ingestedAt, verdict, and studyRevisionId. State written before this contract may carry schemaVersion instead of kind; 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 feasibilityHandoff is 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, or deferred. Treat concern hints as advisory evidence only.

  • Allocate final FR-###, NFR-###, or CON-### 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_V1 and PRD_QUALITY_REPORT_V1 per 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/)
BRD references (references/brd/)
PRD references (references/prd/)

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:

Contractschema_versionReference
Standard findingsBRD_STANDARD_FINDINGS_V1brd-standard-findings-v1.md
Quality reportBRD_QUALITY_REPORT_V1brd-quality-report-v1.md
BRD-to-PRD handoffBRD_TO_PRD_HANDOFF_V1brd-to-prd-handoff-v1.md

PRD data contracts:

Contractschema_versionReference
Standard findingsPRD_STANDARD_FINDINGS_V1prd-standard-findings-v1.md
Quality reportPRD_QUALITY_REPORT_V1prd-quality-report-v1.md

Upstream PRD input contracts:

ContractIdentifierReference
BRD-to-PRD handoffschema_version: BRD_TO_PRD_HANDOFF_V1brd-to-prd-handoff-v1.md
Feasibility-to-PRD handoffkind: feasibility-to-prd-handofffeasibility-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:

PhaseSection anchorRequired phaseSkillsLoaded entry
Discover#discoverbrd-author#discover
Define#definebrd-author#define
Govern#governbrd-author#govern

PRD Builder directives:

PhaseSection anchorRequired phaseSkillsLoaded entry
Assess#prd-assessprd-author#assess
Discover#prd-discoverprd-author#discover
Create#prd-createprd-author#create
Build#prd-buildprd-author#build
Integrate#prd-integrateprd-author#integrate
Validate#prd-validateprd-author#validate
Finalize#prd-finalizeprd-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

references/prd/prd-quality-report-v1.md


description: 'PRD_QUALITY_REPORT_V1 schema - PRD-level quality report emitted by PRD Quality Reviewer with gate decisions, thresholds, summaries, and recommendations'

PRD Quality Report — PRD_QUALITY_REPORT_V1

This document defines the PRD_QUALITY_REPORT_V1 payload emitted by the PRD Quality Reviewer subagent (prd-quality-reviewer). One payload is produced per Validate-exit, Finalize-exit, Finalize drift, or on-request PRD quality run in the same invocation as the paired PRD_STANDARD_FINDINGS_V1 payload. The PRD payload mirrors the BRD-side BRD_QUALITY_REPORT_V1 shape, diverging only where the PRD lifecycle gates, NFR taxonomy, and identifier set differ.

Purpose

The payload provides the PRD Builder orchestrator with the only quality gate decision record. It owns gate_decisions.validate_exit, gate_decisions.finalize_exit, and the threshold-to-decision rules that convert reviewer findings into gate outcomes.

Format

The payload is YAML.

schema_version: PRD_QUALITY_REPORT_V1
report_id: <REPORT_ID>
generated_at: <ISO_8601_TIMESTAMP>
prd:
  id: <PRD_ID>
  version: <PRD_VERSION>
  phase: <PRD_PHASE>
  artifact_path: <PRD_ARTIFACT_PATH>
overall_status: <OVERALL_STATUS>
decision_thresholds:
  iso_29148_core_min_score: <MIN_CORE_SCORE>
  fr_to_ac_min_pct: <FR_AC_MIN_PCT>
  fr_to_goal_target_pct: <FR_GOAL_TARGET_PCT>
gate_decisions:
  validate_exit: <GATE_DECISION>
  finalize_exit: <GATE_DECISION>
summary_counts:
  RISK: <RISK_COUNT>
  CAUTION: <CAUTION_COUNT>
  COVERED: <COVERED_COUNT>
  NOT_APPLICABLE: <NA_COUNT>
severity_breakdown:
  CRITICAL: <CRITICAL_COUNT>
  HIGH: <HIGH_COUNT>
  MEDIUM: <MEDIUM_COUNT>
  LOW: <LOW_COUNT>
standards_assessed:
  - skill_name: <STANDARD_SKILL_NAME>
    skill_version: <STANDARD_SKILL_VERSION>
    overall_status: <STANDARD_OVERALL_STATUS>
    findings_ref: <FINDINGS_PAYLOAD_PATH>
    findings_count: <FINDINGS_COUNT>
category_summaries:
  iso_29148:
    average_score: <AVERAGE_SCORE>
    weakest_attribute: <ATTRIBUTE_NAME>
    weakest_attribute_score: <ATTRIBUTE_SCORE>
  nist_800_160:
    covered_categories: <COVERED_COUNT>
    missing_categories:
      - <CATEGORY_NAME>
  smart:
    goals_total: <GOALS_TOTAL>
    goals_passing: <GOALS_PASSING>
    pass_rate_pct: <PASS_RATE_PCT>
  fr_ac_coverage:
    fr_total: <FR_TOTAL>
    fr_with_ac: <FR_WITH_AC>
    coverage_pct: <COVERAGE_PCT>
    threshold_pct: <THRESHOLD_PCT>
  fr_goal_coverage:
    fr_total: <FR_TOTAL>
    fr_with_goal: <FR_WITH_GOAL>
    goal_total: <GOAL_TOTAL>
    coverage_pct: <COVERAGE_PCT>
    target_pct: <TARGET_PCT>
    waiver_required: <BOOLEAN>
top_findings:
  - finding_id: <FINDING_ID>
    standard: <STANDARD_SKILL_NAME>
    severity: <FINDING_SEVERITY>
    status: <FINDING_STATUS>
    location:
      section: <PRD_SECTION>
      line_range: <LINE_RANGE>
    finding: <FINDING_DESCRIPTION>
    recommendation: <RECOMMENDATION>
recommendations:
  - id: <RECOMMENDATION_ID>
    priority: <RECOMMENDATION_PRIORITY>
    target_section: <PRD_SECTION>
    action: <RECOMMENDATION_ACTION>
    related_finding_ids:
      - <FINDING_ID>
warnings:
  - id: <WARNING_ID>
    severity: <WARNING_SEVERITY>
    message: <WARNING_MESSAGE>
    related_finding_ids:
      - <FINDING_ID>
notes: <REPORT_NOTES>

Field definitions

Top-level metadata
  • schema_version (string, required) — MUST be PRD_QUALITY_REPORT_V1.

  • report_id (string, required) — Unique identifier for this report. Recommended form: <prd_id>-quality-<ISO_8601_basic_timestamp>.

  • generated_at (string, required) — ISO 8601 timestamp (UTC) when the report was generated.

prd (object, required)

Same shape as prd in PRD_STANDARD_FINDINGS_V1, minus partition_id. Reports are always PRD-level.

overall_status (string, required)

One of:

  • PASS — No reviewer finding has status: RISK or status: CAUTION, and all threshold rules are met.

  • NEEDS_REVIEW — One or more reviewer findings has status: CAUTION, or a warning-level threshold rule needs acknowledgement or waiver, and no blocking threshold rule is breached.

  • FAIL — One or more reviewer findings has status: RISK, or any blocking threshold rule is breached.

decision_thresholds (object, required)

Thresholds the PRD Quality Reviewer applied when deriving gate_decisions from the paired findings payload.

  • iso_29148_core_min_score (integer, required) — Minimum acceptable score for core ISO 29148 attributes. MUST be 2 unless a future schema version changes the threshold.

  • fr_to_ac_min_pct (number, required) — Minimum FR-to-AC coverage percentage required by the active PRD frontmatter. Default is 80.0 when the PRD does not override it.

  • fr_to_goal_target_pct (number, required) — Target FR-to-product-goal coverage percentage. MUST be 100.0; gaps are waivable only through Finalize signoff.

gate_decisions (object, required)
  • validate_exit (string, required) — One of APPROVED, APPROVED_WITH_COMMENTS, BLOCKED, NOT_EVALUATED. MUST be BLOCKED when overall_status is FAIL.

  • finalize_exit (string, required) — One of APPROVED, APPROVED_WITH_COMMENTS, BLOCKED, NOT_EVALUATED. MUST be NOT_EVALUATED when the PRD phase is any of Assess, Discover, Create, Build, Integrate, or Validate.

summary_counts (object, required)

Integer counts of findings by status from the paired PRD_STANDARD_FINDINGS_V1 payload. Same key set as PRD_STANDARD_FINDINGS_V1.summary_counts. Each value MUST be ≥ 0.

severity_breakdown (object, required)

Integer counts of RISK and CAUTION findings by severity from the paired PRD_STANDARD_FINDINGS_V1 payload. COVERED and NOT_APPLICABLE findings (severity N/A) are excluded.

  • CRITICAL, HIGH, MEDIUM, LOW (integer, required, ≥ 0).

standards_assessed (array, required)

Single-element reviewer assessment array. The array shape is retained for compatibility with existing consumers, but PRD Quality Reviewer MUST emit exactly one entry representing its combined requirements quality review. It is not a multi-subagent fan-in list.

  • skill_name (string, required) — Reviewer rubric skill bundle name. Use requirements-quality for the combined PRD quality review.

  • skill_version (string, required) — spec_version of the reviewer rubric skill.

  • overall_status (string, required) — Mirrors the paired PRD_STANDARD_FINDINGS_V1.overall_status.

  • findings_ref (string, optional) — Workspace-relative path to the persisted PRD_STANDARD_FINDINGS_V1 payload, when persisted by the orchestrator. Omit when the report and findings are returned inline.

  • findings_count (integer, required, ≥ 0).

category_summaries (object, required)

Rollup statistics derived from the paired PRD_STANDARD_FINDINGS_V1 payload.

  • iso_29148 (object, required when any assessed standard emits iso_29148_attributes; otherwise OPTIONAL).

    • average_score (number, required) — Mean of the nine per-attribute scores, rounded to two decimals.

    • weakest_attribute (string, required) — Name of the lowest-scoring attribute. Ties resolved by listed order: necessary, appropriate, unambiguous, complete, singular, feasible, verifiable, correct, conforming.

    • weakest_attribute_score (integer, required, 0–3).

  • nist_800_160 (object, required when any assessed standard emits nist_800_160_nfr_categories; otherwise OPTIONAL).

    • covered_categories (integer, required, 0–10).

    • missing_categories (array of strings, required) — Names of categories whose presence boolean is false. Empty array when all ten categories are covered.

  • smart (object, required when any assessed standard emits smart_product_goals; otherwise OPTIONAL).

    • goals_total (integer, required, ≥ 0).

    • goals_passing (integer, required, 0 ≤ value ≤ goals_total).

    • pass_rate_pct (number, required, 0.0–100.0) — 100 * goals_passing / goals_total when goals_total > 0; 100.0 otherwise.

  • fr_ac_coverage (object, required when any assessed standard emits fr_ac_coverage; otherwise OPTIONAL).

    • Same shape as PRD_STANDARD_FINDINGS_V1.fr_ac_coverage.

    • threshold_pct (number, required) — Threshold applied for Validate-exit decisioning.

  • fr_goal_coverage (object, required when the PRD contains functional requirements or product goals; otherwise OPTIONAL).

    • fr_total (integer, required, ≥ 0).

    • fr_with_goal (integer, required, 0 ≤ value ≤ fr_total) — Count of functional requirements linked to at least one product goal.

    • goal_total (integer, required, ≥ 0) — Count of product goals detected in the PRD.

    • coverage_pct (number, required, 0.0–100.0) — 100 * fr_with_goal / fr_total when fr_total > 0; 0.0 when fr_total == 0.

    • target_pct (number, required) — Target coverage percentage, normally 100.0.

    • waiver_required (boolean, required) — true when coverage_pct is below target_pct.

top_findings (array, required)

Up to ten findings selected for executive surfacing. Selection rule: take all RISK findings first (ordered by severity then by appearance in the underlying payloads), then CAUTION findings, up to ten total.

Each entry:

  • finding_id (string, required) — Same value as in the source PRD_STANDARD_FINDINGS_V1.findings[].finding_id.

  • standard (string, required) — Source reviewer rubric skill name.

  • severity (string, required) — CRITICAL, HIGH, MEDIUM, LOW. N/A is forbidden in top_findings.

  • status (string, required) — RISK or CAUTION. COVERED and NOT_APPLICABLE are forbidden in top_findings.

  • location, finding, recommendation — same shape as in PRD_STANDARD_FINDINGS_V1.findings.

recommendations (array, required)

Zero or more prioritized actions the author should take before re-requesting the gate. Each entry consolidates one or more underlying findings into a single coaching item.

  • id (string, required) — Unique within the payload. Recommended form: REC-<sequence>.

  • priority (string, required) — P0, P1, P2, P3. P0 MUST be used when any related finding has severity CRITICAL; P1 when any related finding has severity HIGH.

  • target_section (string, required) — PRD section the author should revise.

  • action (string, required) — Concrete revision instruction.

  • related_finding_ids (array of strings, required, length ≥ 1) — Finding IDs from PRD_STANDARD_FINDINGS_V1.findings[].finding_id.

warnings (array, optional)

Zero or more non-finding warnings the orchestrator or author should consider. Use warnings for calibration caveats, waivable coverage gaps, partial source availability, or drift context that does not belong to a single finding.

  • id (string, required) — Unique within the payload. Recommended form: WARN-001.

  • severity (string, required) — One of INFO, WARNING, ADVISORY.

  • message (string, required) — Concise warning text.

  • related_finding_ids (array of strings, optional) — Finding IDs from PRD_STANDARD_FINDINGS_V1.findings[].finding_id.

notes (string, optional)

Free-form reviewer commentary (for example calibration warnings, missing source caveats, or drift review context).

Validation rules

  1. schema_version MUST equal PRD_QUALITY_REPORT_V1.

  2. overall_status MUST be consistent with the paired findings payload and threshold rules:

    • FAIL if summary_counts.RISK > 0.

    • FAIL if any core ISO 29148 attribute (necessary, unambiguous, singular, or verifiable) scores below decision_thresholds.iso_29148_core_min_score.

    • FAIL if category_summaries.fr_ac_coverage.coverage_pct is below decision_thresholds.fr_to_ac_min_pct.

    • NEEDS_REVIEW if no fail condition is present and summary_counts.CAUTION > 0.

    • NEEDS_REVIEW if no fail condition is present and category_summaries.fr_goal_coverage.waiver_required is true.

    • PASS otherwise.

  3. ISO 29148 score 1 maps to CAUTION in general rubric scoring, but any core ISO 29148 attribute below 2 is blocking through this report's threshold rules.

  4. gate_decisions.validate_exit MUST be BLOCKED when overall_status is FAIL.

  5. gate_decisions.validate_exit MUST be APPROVED_WITH_COMMENTS when overall_status is NEEDS_REVIEW.

  6. gate_decisions.validate_exit MAY be APPROVED only when overall_status is PASS.

  7. gate_decisions.finalize_exit MUST be NOT_EVALUATED when prd.phase is any of Assess, Discover, Create, Build, Integrate, or Validate.

  8. gate_decisions.finalize_exit MUST be BLOCKED when prd.phase is Finalize, overall_status is FAIL, and no approved waiver covers the blocking condition.

  9. gate_decisions.finalize_exit MUST be APPROVED_WITH_COMMENTS when prd.phase is Finalize, no blocking condition remains, and warnings or waivable coverage gaps remain.

  10. summary_counts.* MUST equal the corresponding counts in the paired PRD_STANDARD_FINDINGS_V1 payload.

  11. severity_breakdown.* MUST equal the count of RISK and CAUTION findings at each severity in the paired findings payload.

  12. standards_assessed MUST have exactly one entry when produced by PRD Quality Reviewer.

  13. Every recommendations[].id MUST be unique within the payload.

  14. Every recommendations[].related_finding_ids[] value MUST exist as a findings[].finding_id in the paired PRD_STANDARD_FINDINGS_V1 payload.

  15. Every warnings[].id, when present, MUST be unique within the payload.

  16. top_findings MUST contain only RISK and CAUTION items; length MUST be ≤ 10.

Example payload

schema_version: PRD_QUALITY_REPORT_V1
report_id: PRD-2026-014-quality-20260612T141055Z
generated_at: "2026-06-12T14:10:55Z"
prd:
  id: PRD-2026-014
  version: 0.4.0
  phase: Validate
  artifact_path: docs/prds/2026/prd-checkout-redesign.md
overall_status: FAIL
decision_thresholds:
  iso_29148_core_min_score: 2
  fr_to_ac_min_pct: 80.0
  fr_to_goal_target_pct: 100.0
gate_decisions:
  validate_exit: BLOCKED
  finalize_exit: NOT_EVALUATED
summary_counts:
  RISK: 3
  CAUTION: 4
  COVERED: 14
  NOT_APPLICABLE: 2
severity_breakdown:
  CRITICAL: 0
  HIGH: 2
  MEDIUM: 4
  LOW: 1
standards_assessed:
  - skill_name: requirements-quality
    skill_version: "1.0"
    overall_status: RISK
    findings_ref: .copilot-tracking/quality/2026-06-12/PRD-2026-014/req-qual-findings.yml
    findings_count: 23
category_summaries:
  iso_29148:
    average_score: 2.44
    weakest_attribute: unambiguous
    weakest_attribute_score: 1
  nist_800_160:
    covered_categories: 6
    missing_categories:
      - scalability_and_elasticity
      - maintainability_and_operability
      - observability
      - compatibility_and_interoperability
  smart:
    goals_total: 3
    goals_passing: 2
    pass_rate_pct: 66.67
  fr_ac_coverage:
    fr_total: 18
    fr_with_ac: 15
    coverage_pct: 83.33
    threshold_pct: 80.0
  fr_goal_coverage:
    fr_total: 18
    fr_with_goal: 16
    goal_total: 3
    coverage_pct: 88.89
    target_pct: 100.0
    waiver_required: true
top_findings:
  - finding_id: req-qual-001
    standard: requirements-quality
    severity: HIGH
    status: RISK
    location:
      section: "6. Functional Requirements"
      line_range: L142-L148
    finding: FR-001 uses the unqualified term "fast" without a measurable threshold.
    recommendation: Restate FR-001 with a quantitative latency target (for example "render the cart within 1 second of update").
  - finding_id: req-qual-002
    standard: requirements-quality
    severity: HIGH
    status: RISK
    location:
      section: "1. Executive Summary"
      line_range: L48-L52
    finding: Product goal GOAL-001 has no measurable success metric and fails SMART Measurable.
    recommendation: Add a numeric KPI to GOAL-001 (for example "increase checkout completion rate by 8%").
  - finding_id: req-qual-003
    standard: requirements-quality
    severity: MEDIUM
    status: CAUTION
    location:
      section: "7. Non-Functional Requirements"
    finding: The Observability category contains no NFR naming required logs, metrics, traces, or alerting thresholds.
    recommendation: Add an NFR defining checkout funnel instrumentation and alert thresholds.
recommendations:
  - id: REC-1
    priority: P1
    target_section: "6. Functional Requirements"
    action: Quantify every NFR-style adverb (fast, often, large) currently embedded in FR statements; move performance constraints to the NFR section with measurable thresholds.
    related_finding_ids:
      - req-qual-001
  - id: REC-2
    priority: P1
    target_section: "1. Executive Summary"
    action: Add SMART-compliant KPIs to GOAL-001 and re-confirm GOAL-002 timeline anchors.
    related_finding_ids:
      - req-qual-002
  - id: REC-3
    priority: P2
    target_section: "7. Non-Functional Requirements"
    action: Add NFRs covering observability, scalability, maintainability, and interoperability before Finalize.
    related_finding_ids:
      - req-qual-003
warnings:
  - id: WARN-001
    severity: WARNING
    message: FR-to-product-goal coverage is below the 100% Finalize target and requires an approved waiver before signoff.
    related_finding_ids:
      - req-qual-002
notes: Scalability, maintainability, observability, and interoperability NFR categories are absent; flagged for stakeholder discussion before Finalize (no automatic block).

License

This reference file is original Microsoft content licensed under CC BY 4.0. The schema definition and validation rules are HVE-Core IP and may be reused under the same license.

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