agentdev-workflow-inspect-docs

Diagnoses semantic consistency across REQ, Decision, Design, and guide documentation.

Updated Mar 7, 2026
One-click install
npx skills add https://github.com/yogata/agent-dev-flow --skill agentdev-workflow-inspect-docs-yogata
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: agentdev-workflow-inspect-docs
Source: https://github.com/yogata/agent-dev-flow/tree/main/src/opencode/skills/agentdev-workflow-inspect-docs
Command: npx skills add https://github.com/yogata/agent-dev-flow --skill agentdev-workflow-inspect-docs-yogata

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Documentation sets (requirements, decisions, designs, guides, README) drift out of sync as projects evolve, producing contradictions, stale references, and structural duplication that are hard to catch manually. This Skill automates the semantic diagnosis of an entire docs tree and records findings without modifying the inspected files. ## Core Features & Use Cases - Semantic consistency diagnosis: Scans docs/requirements, docs/decisions, docs/designs, docs/guides, and README, then checks REQ reference ID integrity, current/retired generation boundaries, and six structural review viewpoints (SPLIT/MERGE/MOVE/DUPLICATE/RETIRE/DRIFT). - Distribution integrity checks: Inspects distributed command and skill files for syntax corruption, broken references, encoding inconsistencies, and responsibility-boundary mismatches. - Finding persistence: Writes findings to .agentdev/inspect/inbox/ as timestamped Markdown files and commits/pushes only that directory with a Conventional Commits message. - Use Case: Run the /agentdev/inspect-docs command before a release to detect contradictions between current REQs and approved Decisions, then hand the findings to the inspect-promote workflow for triage. ## Quick Start Run the /agentdev/inspect-docs command to diagnose the semantic consistency of all project documentation and persist the findings to the inspect inbox.

Frequently Asked Questions about agentdev-workflow-inspect-docs

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

FAQPage Schema
How do I check documentation consistency across requirements and design docs?▼

Run the /agentdev/inspect-docs command, which scans docs/requirements, docs/decisions, docs/designs, docs/guides, and README, then diagnoses semantic consistency using source-of-truth priority (current REQ > approved Decision > Design > guides). Findings are written to .agentdev/inspect/inbox/ as timestamped Markdown files.

What does the inspect-docs workflow detect in requirement documents?▼

It checks REQ reference ID integrity, first-reference navigation paths, current/retired/generation boundaries, and runs a six-viewpoint structural review covering SPLIT, MERGE, MOVE, DUPLICATE, RETIRE, and DRIFT. It also verifies document classification consistency against the document-model policy.

Does inspect-docs modify the documentation it inspects?▼

No. It is a read-only diagnostic workflow that never changes files under docs/ or .opencode/. Its only permitted side effects are creating finding files in .agentdev/inspect/inbox/ and committing/pushing changes within .agentdev/inspect/.

Can inspect-docs resume after an interruption?▼

No. It is a read-only-diagnostic type workflow outside the STEP model, so it has no resume points, export, or import. If interrupted, rerun the workflow from the beginning; the diagnosis is idempotent and produces equivalent results.

What happens to findings after inspect-docs generates them?▼

Findings are stored in .agentdev/inspect/inbox/ and committed with the message 'chore(agentdev): capture inspect-docs finding'. Classification, adoption, and disposition of findings are handled separately by the inspect-promote workflow, not by this Skill.