docs-review

Name: docs-review
Availability: InStock
Author: BenchFlow

Detect documentation drift and stale references against the current codebase.

317|40|Updated Jan 21, 2025

Search Tags:#documentation #maintenance #drift-detection #quality-assurance #code-review #technical-writing

Ready to run

npx skills add https://github.com/benchflow-ai/benchflow --skill docs-review-benchflow-ai

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: docs-review
Source: https://github.com/benchflow-ai/benchflow/tree/main/.agents/skills/docs-review
Command: npx skills add https://github.com/benchflow-ai/benchflow --skill docs-review-benchflow-ai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill prevents documentation rot by identifying drift between the codebase and its reference material, ensuring that architecture, CLI flags, and registry entries remain synchronized.

Core Features & Use Cases

Drift Detection: Automatically cross-references project structures, environment variables, and registry entries against the actual source code.
Link & Reference Validation: Verifies the integrity of all internal documentation links, file paths, and function references to prevent broken navigation.
Status Language Cleanup: Identifies outdated implementation-tracking language to ensure documentation reflects current design rather than historical in-flight work.

Quick Start

Invoke the docs-review skill to perform a comprehensive audit of all project documentation for drift and stale references.

Frequently Asked Questions about docs-review

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

FAQPage Schema

How do I detect documentation drift between my codebase and project references?▼

Documentation drift is detected by cross-referencing project structures, environment variables, and registry entries against current source code. This skill systematically verifies file paths and cross-document alignment to identify inconsistencies between the codebase and reference material.

What causes broken links and stale references in technical documentation?▼

Broken links and stale references occur when internal documentation paths and function references become outdated relative to the actual source code. Validating link integrity requires verifying all internal documentation connections against the current repository state.

How do I validate CLI reference documentation against current repository state?▼

Validating CLI reference documentation against the repository state requires systematic verification of CLI flags, file paths, and registry entries. This ensures architecture references and command-line documentation remain synchronized with the actual source code.

Can I audit task-authoring guides for outdated implementation-tracking language?▼

Yes, task-authoring guides can be audited to identify outdated implementation-tracking language. This status language cleanup ensures documentation reflects current design rather than historical in-flight work across architecture and reference materials.

What's the best way to perform a comprehensive documentation audit for codebase synchronization?▼

A comprehensive documentation audit for codebase synchronization requires cross-referencing architecture, CLI reference, and task-authoring guides against the current repository. This detects drift, stale references, and structural inconsistencies across all project documentation.