ada-doc-traceability-audit

Audits SRS, traceability matrices, and documentation against source code for drift.

Updated Jul 23, 2026
One-click install
npx skills add https://github.com/wubing7755/Ada --skill ada-doc-traceability-audit-wubing7755
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ada-doc-traceability-audit
Source: https://github.com/wubing7755/Ada/tree/main/skills/software-development/ada-doc-traceability-audit
Command: npx skills add https://github.com/wubing7755/Ada --skill ada-doc-traceability-audit-wubing7755

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Project documentation drifts out of sync with source code over time: traceability matrices miss requirements, appendices list stale file counts, status markers claim work is done when it is not, and obsolete files clutter the docs tree. This Skill systematically audits documentation against the actual codebase so planning and release decisions rest on accurate information. ## Core Features & Use Cases - Cross-Reference Verification: Compares REQ IDs between the SRS and the traceability matrix, flags missing or extra entries, and reconciles requirement counts. - Appendix and Link Validation: Recounts test and source files against appendix listings, verifies cross-document links resolve, and detects stale status markers like TBD or pending. - Cleanup Decision Tree: Classifies every docs file as keep-active, archive to docs/archive/, or delete, with a concrete calibration example from a real cleanup pass. - Use Case: After a major refactoring phase, run the audit to confirm the SRS count of 152 requirements matches the traceability matrix, all appendix files exist on disk, and superseded quality reports are archived with README links updated. ## Quick Start Audit the docs directory against the current source code and report any traceability gaps, stale status markers, and files that should be archived or deleted.

Frequently Asked Questions about ada-doc-traceability-audit

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

FAQPage Schema
How do I verify a traceability matrix matches the SRS?

Extract all REQ IDs from the SRS and from the traceability matrix with grep, sort them uniquely, and diff the two lists. For each missing REQ, check whether it was deleted per the SRS appendix or is a genuine requirement needing a new traceability row.

How to decide which documentation files to delete or archive?

Check whether the file is referenced from docs/README.md first. Unreferenced files with decision-traceability value, such as completed refactoring plans or baseline snapshots, move to docs/archive/; empty shells and superseded drafts are deleted.

When should I run a documentation traceability audit?

Run it after a major implementation phase changing three or more source files, before a release or API freeze, or when requirement counts disagree between documents. Skip it for single-document typo fixes or greenfield projects without a traceability matrix.

Why do documentation line counts and file counts go stale?

Line counts recorded with wc -l rot on every code change, and appendix totals drift when files are added or removed without recalculation. Always recount from disk during the audit rather than trusting recorded figures.

What is the difference between this audit and a code-vs-matrix evidence check?

This audit covers documentation-internal consistency: SRS entries, matrices, status markers, appendices, and cleanup decisions. For verifying source code evidence against the matrix, use ada-traceability-audit or ada-doc-implementation-audit instead.