Skip to content
Development
Skill

/update-docs

Update all project documentation after code changes.

Boost this skill
@lbb00lbb00@lbb00
From plugin
ai-rules-sync
375 skills
Install
$ npx -y skills add lbb00/ai-rules-sync --skill update-docs --agent claude-code

How it fires

How this skill gets triggered: by you, by Claude, or both.

  • Fires itselfAuto-invocation. Claude auto-loads it when your prompt matches the work.Auto-invocation is when the right skill fires by itself at the right moment, driven by a FLOW.md router and a hook, instead of you invoking it by name. It is the difference between a skill being installed and a skill actually getting used.Read the full definition →
  • You can call itInvoke it directly when you want it.
  • Slash command/update-docs

Context preview

The summary Claude sees to decide when to auto-load this skill.

Update all project documentation after code changes.

SKILL.md

update-docs.SKILL.md
name: update-docs
description: Update all project documentation after code changes.

Update Documentation

Instructions

One-click command to update all project documentation after code changes.

Steps

1. **Analyze Changes**

  • Check git status for modified files
  • Review recent commits if no uncommitted changes
  • Identify what documentation needs updating

2. **Update KNOWLEDGE_BASE.md**

  • Run the `update-knowledge-base` skill
  • Document any architectural or feature changes

3. **Update README.md**

  • Add new features or commands
  • Update examples if API changed
  • Ensure accuracy of all documented commands

4. **Sync README_ZH.md**

  • Run the `sync-readme` skill
  • Ensure Chinese documentation matches English

5. **Verify**

  • Run tests to ensure nothing broken: `npm test`
  • Check that all documented commands work
  • Review diff before committing

When to Use

  • After adding a new adapter
  • After adding or modifying CLI commands
  • After changing the configuration format
  • After any user-facing changes

Output

All documentation files updated and in sync:

  • KNOWLEDGE_BASE.md (if exists)
  • README.md
  • README_ZH.md

Examples

Request: Update all docs after adding OpenCode support Result: KNOWLEDGE_BASE.md, README.md, and README_ZH.md all updated

Read it on GitHub ↗
Ships withai-rules-sync

English · 中文 · Documentation AI Rules Sync (AIS) — Install, compose, update, and publish native agent assets from multiple Git repositories across all your projects. AIS is an asset federation toolkit, not a format converter.

Get the whole plugin
Stats
TypeScriptJavaScriptNodeReactVue
+5 tags
BashGitGitHubAnthropicGemini
37
Stars
1
Forks
Active
Maintenance
TypeScript
Language
Unlicense
License
27d ago
Last commit
8mo ago
Created

Repo: lbb00/ai-rules-sync

In this plugin
5 skills
See everything inside

Other skills on ai-rules-sync.