update-docs

Refresh project documentation after code changes and validate diffs.

35|1|Updated Dec 25, 2025
One-click install
npx skills add https://github.com/lbb00/ai-rules-sync --skill update-docs-lbb00
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-docs
Source: https://github.com/lbb00/ai-rules-sync/tree/main/.claude/skills/update-docs
Command: npx skills add https://github.com/lbb00/ai-rules-sync --skill update-docs-lbb00

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Keeping project documentation up to date after code changes is error-prone and time-consuming. This Skill automates the synchronization of key docs across the repository, reducing drift and manual effort.

Core Features & Use Cases

  • Automatic Documentation Sync: Updates KNOWLEDGE_BASE.md, README.md, and README_ZH.md to reflect recent changes.
  • Cross-File Consistency: Ensures consistency of commands, features, and configurations across documentation.
  • Safe Validation: Runs checks to review diffs before committing to ensure changes are correct and safe.

Quick Start

Run the update-docs skill after completing a set of code changes to refresh all project documentation and prepare diffs for review.

Frequently Asked Questions about update-docs

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

FAQPage Schema
How do I automatically update README.md and KNOWLEDGE_BASE.md after code changes?

You can automatically update README.md and KNOWLEDGE_BASE.md after code changes by running the update-docs skill to synchronize new features, commands, and configurations across your project documentation. It refreshes multiple files to reduce manual effort and prevent documentation drift.

What is the best way to keep project documentation consistent across multiple files?

The best way to keep documentation consistent across multiple files is to use automated synchronization tools that validate diffs and enforce cross-file consistency for commands and configurations. This ensures all markdown documents reflect the same recent code changes accurately.

How does documentation sync validate changes before committing?

Documentation sync validates changes by running optional checks to review diffs before committing, ensuring that updates to features and configurations are correct and safe. This validation step prevents inaccurate documentation from being committed to your repository.

Can I use an automation skill to sync both English and Chinese README files?

Yes, you can use documentation automation to sync both English and Chinese README files. The skill updates README.md and README_ZH.md simultaneously, enforcing cross-file consistency so both language versions reflect the exact same new features and configurations.

When should I run documentation synchronization in my development workflow?

You should run documentation synchronization after completing a set of code changes to refresh all project documentation and prepare diffs for review. Running it at this stage ensures your KNOWLEDGE_BASE.md and README files accurately reflect the latest committed features.

What limitations should I expect with automatic documentation updates?

When using automatic documentation updates, you should expect the process to focus strictly on syncing existing files like README.md and KNOWLEDGE_BASE.md rather than generating new documentation. It validates diffs before committing, meaning manual review is still recommended for complex structural changes.