review-docs

Validate .claude/docs reference documentation for staleness and drift with bactopia-docs --validate.

521|81|Updated Feb 22, 2019
One-click install
npx skills add https://github.com/bactopia/bactopia --skill review-docs-bactopia
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: review-docs
Source: https://github.com/bactopia/bactopia/tree/main/.claude/skills/review-docs
Command: npx skills add https://github.com/bactopia/bactopia --skill review-docs-bactopia

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Review staleness of reference docs under .claude/docs/ using bactopia-docs --validate. Detects deprecated patterns (residue from past migrations) and ground-truth assertions, enabling triage and targeted updates to keep documentation aligned with the repo state.

Core Features & Use Cases

  • Detect deprecated patterns and ground-truth claims across the documentation suite.
  • Provide a consolidated staleness report and actionable triage notes for maintainers.
  • Validate documentation against patterns registry and repository state, ensuring consistency across skills.

Quick Start

Run bactopia-docs --validate and present the staleness report.

Frequently Asked Questions about review-docs

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

FAQPage Schema
How do I detect deprecated patterns and documentation drift in my repository?

Documentation drift is detected by validating reference docs against repository state and pattern registries. This identifies stale ground-truth claims and residue from past migrations, generating a consolidated staleness report for maintainers to triage.

What is documentation drift and when should I audit my docs for staleness?

Documentation drift occurs when reference docs become misaligned with repository state. Audit for staleness to catch outdated CLI references, deprecated patterns, and invalid ground-truth claims across your documentation suite before they mislead users.

How do I validate documentation against nextflow.config and pattern registries?

Documentation is validated against data/docs-patterns.yml, nextflow.config, and linked references using a validation tool. This cross-referencing checks CLI references and lint IDs to ensure documentation accurately reflects the current repository configuration.

Can I audit cross-skill documentation consistency across an entire repository?

Yes, validation checks apply across the entire repository to catch cross-skill documentation drift. This ensures consistency across all skills by verifying that linked references and ground-truth claims match the actual repository state.

What is the best way to triage outdated reference docs and generate a staleness report?

Run a validation process that checks reference documentation against repository state to generate a consolidated staleness report. This provides actionable triage notes, enabling targeted updates to keep documentation aligned with the codebase.