Skip to content

Add traceability audit template for cross-document specification drift#35

Merged
Alan-Jowett merged 8 commits intomicrosoft:mainfrom
Alan-Jowett:add-traceability-audit-template
Mar 20, 2026
Merged

Add traceability audit template for cross-document specification drift#35
Alan-Jowett merged 8 commits intomicrosoft:mainfrom
Alan-Jowett:add-traceability-audit-template

Conversation

@Alan-Jowett
Copy link
Member

Summary

Adds a new template that audits requirements, design, and validation documents for specification drift — gaps, contradictions, and divergence that accumulate as documents evolve independently.

New Components

Component File Purpose
Persona \personas/specification-analyst.md\ Adversarial-toward-completeness mindset; cross-examines documents for gaps
Taxonomy \ axonomies/specification-drift.md\ D1–D7 drift classification (D8+ reserved for future code/test audits)
Protocol \protocols/reasoning/traceability-audit.md\ 6-phase cross-document comparison methodology
Template \ emplates/audit-traceability.md\ Single-shot audit; design doc optional

Drift Taxonomy (D1–D7)

Label Description
D1 Untraced requirement — REQ-ID not referenced in design
D2 Untested requirement — REQ-ID has no test case
D3 Orphaned design decision — no originating requirement
D4 Orphaned test case — no linked requirement
D5 Assumption drift — cross-document assumption conflict
D6 Constraint violation — design violates stated constraint
D7 Acceptance criteria mismatch — test doesn't verify the criteria

D8–D13 are reserved for future \�udit-code-compliance\ and \�udit-test-compliance\ templates.

Pipeline Extension

Extends \document-lifecycle\ with stage 4:

\
requirements → design → validation → audit (NEW)
\\

Other Changes

  • manifest.yaml: Added all 4 components + pipeline stage 4
  • README.md: Added persona, protocol, taxonomy, and template to component tables; added use case section with CLI example

Validation

  • \ ests/validate-manifest.py\ passes ✅

Add a new template that audits requirements, design, and validation
documents for specification drift — gaps, contradictions, and divergence
that accumulate as documents evolve independently.

New components:
- Persona: specification-analyst — adversarial toward completeness claims
- Taxonomy: specification-drift (D1-D7) — classifies drift types with
  D8+ reserved for future code/test compliance audits
- Protocol: traceability-audit — 6-phase cross-document comparison
- Template: audit-traceability — single-shot, design doc optional

Also extends the document-lifecycle pipeline with stage 4 (audit) and
adds a use case section to README.md.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings March 20, 2026 01:23
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new PromptKit “traceability audit” capability to help users detect and classify cross-document specification drift across requirements, design, and validation artifacts, extending the document-lifecycle pipeline with an audit stage.

Changes:

  • Introduces new components: specification-analyst persona, traceability-audit reasoning protocol, specification-drift taxonomy (D1–D7), and audit-traceability template.
  • Extends manifest.yaml to register the new components and adds a 4th pipeline stage to document-lifecycle.
  • Updates README.md to document the new components and add a usage example.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
templates/audit-traceability.md New template orchestrating the traceability audit workflow and output mapping.
protocols/reasoning/traceability-audit.md New 6-phase methodology for bidirectional traceability + consistency checks.
taxonomies/specification-drift.md New D1–D7 classification scheme for drift findings (plus reserved ranges).
personas/specification-analyst.md New persona defining an evidence-driven, completeness-adversarial auditor stance.
manifest.yaml Registers the new persona/protocol/taxonomy/template and adds pipeline stage 4.
README.md Documents the new components and adds a “Specification Traceability Audit” use case.

Alan Jowett and others added 2 commits March 19, 2026 18:43
Document the phased evolution from cross-document spec audits (shipped)
through bidirectional code/spec audits, invariant extraction, and
standards/protocol analysis. Includes vision for continuous semantic
integration as a CI consumer of PromptKit prompts.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings March 20, 2026 01:43
Walks through an auth service example: three documents authored weeks
apart, with accumulated drift (missing test coverage, scope creep,
constraint violation, stale REQ-ID references). Shows before/after
comparison and explains why each component contributes to the result.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.

Alan Jowett and others added 2 commits March 19, 2026 18:50
Curated gallery of real-world scenarios showing when and why to use
each template. Each scenario is a short paragraph: the problem, which
components are assembled, and what you get. Covers 9 existing templates
and 4 roadmap items. Bridges the gap between one-line descriptions
in the README and full case study walkthroughs.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Fix ordering conflict: use severity-first ordering with taxonomy
  ranking as tiebreaker within severity tiers (protocol, template,
  taxonomy)
- Fix pipeline stage 4 consumes: remove optional design-document
- Fix input_contract type: use validation-plan (matches pipeline stage)
- Fix hyphen: cross document -> cross-document in persona

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings March 20, 2026 01:58
The CLI assembler now includes taxonomies in assembled prompts, matching
the bootstrap.md composition order (Identity -> Protocols -> Taxonomy ->
Format -> Task). Templates declare taxonomies via a 'taxonomies' field
in YAML frontmatter; the assembler resolves them from the manifest.

This fixes the gap where taxonomy definitions (e.g., specification-drift
D1-D7 labels) were not included when using 'promptkit assemble'.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 12 out of 13 changed files in this pull request and generated 9 comments.

Files not reviewed (1)
  • cli/package-lock.json: Language not supported

…accidental files

- Fix README pipeline diagram: design is optional, not 'all three'
- Fix case study CLI command: use @alan-jowett/promptkit package name
- Fix scenarios.md: correct the 'design drift' scenario to use all
  three docs (design is optional, not validation)
- Remove accidentally committed create_pptx*.py files

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants