skills.rest
ibalasite
ibalasiteCOMMUNITY
Explore all skills by this author →
GitHub

gendoc-align-check

Scan documentation, code, and tests to report upstream-downstream alignment gaps.

Updated Apr 22, 2026
Search Tags:#documentation#quality#alignment#traceability#bdd#upstream-downstream
One-click install
npx skills add https://github.com/ibalasite/gendoc --skill gendoc-align-check
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: gendoc-align-check
Source: https://github.com/ibalasite/gendoc/tree/main/skills/gendoc-align-check
Command: npx skills add https://github.com/ibalasite/gendoc --skill gendoc-align-check

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Scans project alignment across documentation, code, and tests to surface upstream-downstream issues automatically, generating a complete hierarchical report that only lists problems and does not perform fixes.

Core Features & Use Cases

  • Global alignment scan across BRD, PRD, PDD, VDD, EDD, ARCH, API, SCHEMA, FRONTEND, test-plan, RTM, and code, indicating upstream/downstream relationships.
  • Outputs a structured report with severity levels (CRITICAL/HIGH/MEDIUM/LOW) and clear sources, ready to drive remediation or feed into fix tooling.
  • Can be called independently or used as a pre-step to gendoc-align-fix to ensure alignment before changes.

Quick Start

Run gendoc-align-check to generate a comprehensive alignment report across all upstream and downstream references.

Frequently Asked Questions about gendoc-align-check

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

FAQPage Schema
How do I check alignment gaps across documentation, code, and tests?▼

You can trace upstream-downstream alignment by scanning project artifacts like BRD, PRD, test-plans, and codebases. This generates a hierarchical report that tags issues with severity levels and annotates traceability relationships.

What is upstream-downstream traceability in software documentation?▼

Upstream-downstream traceability maps relationships between project artifacts like BRD, PRD, ARCH, and tests. Scanning these artifacts surfaces alignment gaps where downstream code or tests diverge from upstream requirements, producing a structured report of mismatched references.

How do I generate a traceability matrix report for BDD test plans and code?▼

Generate a traceability report by scanning your test-plan, RTM, and codebases against upstream documents. The scan outputs a hierarchical report highlighting alignment issues, annotated with CRITICAL, HIGH, MEDIUM, or LOW severity levels for each detected gap.

Does the alignment scan automatically fix gaps found in PRD and API schemas?▼

No, the alignment scan does not automatically fix gaps found in PRD and API schemas. It only produces a hierarchical report listing issues with severity tags, designed to drive manual remediation or feed into a separate fix tooling step.

What documents do I need before running a project alignment scan?▼

Before running a project alignment scan, you need your upstream and downstream artifacts available, such as BRD, PRD, PDD, VDD, EDD, ARCH, API, SCHEMA, FRONTEND, test-plan, RTM, and codebases. The scan cross-references these items to detect gaps.

Related Skills

Explore More Software Engineering Skills→
ibalasiteibalasite

gendoc

Generate engineering documents from templates and upstream sources.

Community
Advanced
sunrain520sunrain520
72

spec-first:analyze

Analyzes specification documents for consistency issues and generates a severity-graded report.

Community
Advanced
vladm3105vladm3105
16

test-automation

Generate executable test suites from SDD artifacts across multiple frameworks.

Community
Advanced
keshavraj936keshavraj936

lint-and-validate

Lint and statically analyze Node.js and Python code modifications.

Community
Intermediate