update-doc

Align repository documentation with code evidence using minimal patches.

29|5|Updated Mar 13, 2026
One-click install
npx skills add https://github.com/johnqtcg/awesome-skills --skill update-doc-johnqtcg
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-doc
Source: https://github.com/johnqtcg/awesome-skills/tree/main/skills/update-doc
Command: npx skills add https://github.com/johnqtcg/awesome-skills --skill update-doc-johnqtcg

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Keeps repository documentation synchronized with the latest code evidence, ensuring docs stay accurate and reducing stale information across README s, CODEMAPS, and developer guides.

Core Features & Use Cases

  • Evidence-driven updates: uses repository files as the single source of truth to patch documentation.
  • Diff-scoped patches: minimizes changes by applying only the necessary edits to align with code changes.
  • Drift prevention: detects gaps between code and docs and generates minimal patches to close them.
  • Use case: after a refactor or API change, update the docs to reflect the new behavior with verifiable evidence.

Quick Start

Run the doc-drift workflow to align project documentation with code changes.

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 code changes across a monorepo?

To keep documentation in sync with code changes across a monorepo, you can run an automated doc-drift workflow that uses repository files as the single source of truth and generates minimal, diff-scoped patches for your READMEs and CODEMAPS.

What is docs-drift and how do I detect it after refactoring?

Docs-drift is the gap between your current codebase and your repository documentation. You detect it by running a workflow that surfaces evidence-backed updates, comparing repository files against existing docs and marking any missing information as Not found in repo.

How do I update README files automatically based on codebase evidence?

You update README files automatically by applying a workflow that enforces repository files as the truth and outputs minimal patches to align the documentation with new code behavior while preserving the existing structure of the files.

Can I generate diff-scoped patches to prevent stale documentation?

Yes, you can prevent stale documentation by generating diff-scoped patches that minimize changes, applying only the necessary edits required to align your docs with specific code updates rather than rewriting entire files.

Does updating docs with this method preserve the original markdown structure?

Yes, the update process explicitly preserves the existing structure of your documentation by outputting minimal patches that align the content with the codebase without unnecessarily altering the original formatting.