doc-update

Audit project documentation against the current codebase and file beads for gaps.

Updated Feb 20, 2026

Search Tags:#documentation #audit #quality-assurance #workflows #task-dispatch #code-doc-sync #gap-beads

Ready to run

npx skills add https://github.com/ChrisSteinbach/claude-skills --skill doc-update-chrissteinbach

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: doc-update
Source: https://github.com/ChrisSteinbach/claude-skills/tree/main/doc-update
Command: npx skills add https://github.com/ChrisSteinbach/claude-skills --skill doc-update-chrissteinbach

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Audit documentation against the current code state, identify gaps, and file beads for every missing or inaccurate piece, with an optional path to dispatch an agent team to address them.

Core Features & Use Cases

Document-state alignment: verify that README files, inline docs, CLI help, and configuration docs reflect the actual codebase.
Gap filing: create beads for every identified gap with detailed context and acceptance criteria to guide fix work.
Optional dispatch: trigger an agent team to implement fixes and synchronize documentation with implementation.

Quick Start

Run a full documentation audit, generate beads for each gap, and optionally dispatch an agent team to address them.

Frequently Asked Questions about doc-update

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

FAQPage Schema

How do I audit project documentation against my current codebase?▼

Documentation audits verify that README files, inline docs, CLI help, and configuration docs reflect the actual codebase by detecting stale, missing, or incorrect content. You can narrow the scope using file paths, directories, globs, or recent changes.

Can I scope a documentation audit to specific files or recent changes?▼

Yes, you can narrow the audit scope by providing file paths, directories, globs, or recent changes. If you omit these parameters, the audit covers all documentation across the entire project.

What information is captured when filing beads for documentation gaps?▼

Filing beads for documentation gaps captures the gap description, current text, code location, file paths, acceptance criteria, and a finding category. This context is generated using bd create to guide fix work.

How do I automatically fix documentation gaps after an audit?▼

After identifying and filing beads for documentation gaps, you can optionally dispatch an agent team to implement fixes and synchronize documentation with the current codebase implementation.

What types of documentation does a code-doc sync audit check?▼

A code documentation audit verifies README files, inline docs, CLI help, and configuration docs against the actual codebase. It detects stale, missing, or incorrect content across all these documentation types.

Do I need any dependencies to run a documentation gap audit?▼

No external dependencies are required to run a documentation gap audit. The tool independently scans project documentation against the codebase and creates beads via bd create for each identified gap.