doc-sys-reviewer_skill

This skill performs comprehensive SYS content review to verify ADR alignment, quality attribute coverage, and interface completeness for reliable REQ

Python

9

GitHub Stars

1

Bundled Files

2 months ago

Catalog Refreshed

4 months ago

First Indexed

Readme & install

Copy the install command, review bundled files from the catalogue, and read any extended description pulled from the listing source.

Installation

Preview and clipboard use veilstrat where the catalogue uses aiagentskills.

npx veilstrat add skill vladm3105/aidoc-flow-framework --skill doc-sys-reviewer

SKILL.md17.9 KB

Overview

This skill performs comprehensive content review and quality assurance for System Requirements (SYS) documents. It validates requirement completeness, ensures ADR alignment, checks quality attribute coverage and interface definitions, and flags items that need manual architectural review. The skill produces a review score and a categorized issue list to guide remediation.

How this skill works

The reviewer loads one or multiple SYS documents, enforces the nested folder structure, and runs a set of checks: functional requirement completeness, ADR traceability, quality attribute coverage, interface definition completeness, constraints, placeholder detection, naming compliance, and upstream drift. A mandatory drift cache (.drift_cache.json) is used to detect ADR changes; the tool updates the cache, computes hashes, and reports drift. Results include auto-fix where safe and flags for manual review when content issues cannot be fixed automatically.

When to use it

Immediately after SYS generation (post doc-sys-autopilot)
After manual edits to any SYS document
Before running requirement generation (pre-doc-req-autopilot)
During architecture or design reviews to validate alignment
As part of periodic quality audits on existing SYS

Best practices

Ensure all SYS files follow the nested folder rule before running review
Initialize and maintain the drift cache so ADR changes are tracked
Address blocking structure errors first (they stop other checks)
Provide ADR references for each requirement to improve traceability
Resolve high-severity drift and ADR conflict warnings before REQ generation

Example use cases

Validate a freshly generated SYS-01_f1_iam.md before moving to REQ creation
Run a periodic sweep to detect ADR drift across all SYS documents
Review manual content edits to ensure naming and ID formats remain compliant
Audit non-functional coverage (performance, security, availability) before release
Surface interface definition gaps for upcoming integration planning

FAQ

Structure compliance is blocking: SYS files must be in the required nested folder layout and named correctly before deeper checks proceed.

Is the drift cache required?

Yes. The drift cache is mandatory for upstream drift detection; the skill will initialize it if missing and update hashes during review.