update-doc

Detect outdated documentation and generate targeted updates from codebase changes.

Updated Jan 23, 2026
One-click install
npx skills add https://github.com/brainfish-ai/devdoc --skill update-doc-brainfish-ai
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-doc
Source: https://github.com/brainfish-ai/devdoc/tree/main/public-apis/meta/.claude/skills/update-doc
Command: npx skills add https://github.com/brainfish-ai/devdoc --skill update-doc-brainfish-ai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Keeping project documentation in sync with rapidly evolving code is tedious and error-prone. This Skill guides and automates updates by focusing on code-derived changes and surfacing discrepancies between docs and implementation.

Core Features & Use Cases

  • Codebase sync: Detect outdated pages and propose precise updates to align docs with current source.
  • Change-driven updates: Generate targeted edits (signatures, examples, navigation) based on code changes.
  • Quality workflow: Provide an approval step before applying updates to preserve prose and context.

Quick Start

Start by scanning your repository for documentation drift and prepare a change plan. Then review and apply updates through the guided workflow.

Frequently Asked Questions about update-doc

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

FAQPage Schema
How do I keep documentation in sync with codebase updates?

To keep documentation in sync with codebase updates, scan your repository to detect outdated sections, check for feature flags and duplicates, and use the guided approval workflow to apply targeted edits only where needed.

What is the best way to detect outdated pages in MDX documentation?

Detecting outdated pages in MDX documentation involves scanning the source code to surface discrepancies between the docs and the current implementation, checking for duplicates, and proposing precise updates to align the content.

Can I review documentation changes before they are applied to the codebase?

Yes, you can review documentation changes before they are applied. The workflow enforces an approval step where you review the proposed targeted edits to signatures and examples before applying changes.

How do I generate targeted doc edits based on code changes?

You generate targeted doc edits by aligning docs with current source code, which creates a change plan for signatures and examples, ensuring updates apply only to sections needing synchronization.

Does the documentation update workflow preserve existing prose and context?

Yes, the documentation update workflow preserves existing prose and context by enforcing an approval step before applying changes, ensuring updates align with the codebase without overwriting valid content.

When should I not use an automated documentation sync workflow?

Avoid automated documentation sync when preserving manual prose context is critical without review, as the workflow applies changes only after an approval step to prevent unwanted content modifications.