ce-adr-gap-analyzer

Identify gaps between ADR intent and realized implementation and documentation.

78|15|Updated May 1, 2023
One-click install
npx skills add https://github.com/Moffran/calibrated_explanations --skill ce-adr-gap-analyzer
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ce-adr-gap-analyzer
Source: https://github.com/Moffran/calibrated_explanations/tree/main/.claude/skills/ce-adr-gap-analyzer
Command: npx skills add https://github.com/Moffran/calibrated_explanations --skill ce-adr-gap-analyzer

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

ADR-driven projects often misalign decisions with implementations and documentation. This skill identifies and reports gaps between the intent of architecture decision records (ADRs) and their realized code, tests, and RTD, generating a dated gap report that surfaces unresolved items for remediation.

Core Features & Use Cases

  • Understand ADR intent: read ADR texts to extract decisions, requirements, and rationale, and map them to code, tests, and docs.
  • Verify compliance: check repositories to ensure implementations satisfy stated decisions, surface misalignments, and produce evidence-backed gaps.
  • Update governance: generate a stamped compliance line for ADR status appendices and prepare remediation guidance.

Quick Start

Run the ADR gap analyzer across the repository to produce a dated gap report for unresolved ADRs.

Frequently Asked Questions about ce-adr-gap-analyzer

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I check if my code matches architecture decision records?

To verify code compliance with architecture decision records, you analyze repository source code, tests, and docs against ADR intent. This identifies evidence-backed gaps with file and line pointers, producing a dated gap report for unresolved items.

What is ADR gap analysis in software engineering?

ADR gap analysis extracts decisions from architecture decision records and maps them to realized code and documentation. It surfaces misalignments between intended architecture and actual implementation, producing evidence-backed gaps for remediation.

How do I generate an ADR compliance report for a software project?

Generate an ADR compliance report by sweeping a single ADR or all appendix records to verify implementations satisfy stated decisions. The output includes severity scores, evidence-backed gaps, and a stamped compliance line for the ADR status appendix.

Can I analyze a single ADR instead of all records in the repository?

Yes, you can analyze a single ADR by targeting a specific record like ADR-004. The analyzer reads the individual ADR text, extracts its decisions, and checks the relevant code, tests, and documentation for compliance gaps.

What is the best way to update ADR status appendices after a code review?

The best way to update ADR status appendices is to run a compliance verification sweep across the repository. This produces a stamped compliance line and a dated gap report to append, ensuring governance reflects the current implementation state.

Why does my software implementation diverge from the documented architecture decisions?

Your software implementation diverges from documented architecture decisions when code and tests evolve without updating the ADR or RTD. A gap analysis maps the intended decisions to the current codebase, highlighting unresolved misalignments with severity scores.