Skills Guide

Update Documentation

VerifiedSafe

Updates all project documentation after code changes. Analyzes git status and recent commits, then updates KNOWLEDGE_BASE.md, README.md, and the Chinese README. Ensures documentation stays accurate and in sync with the codebase.

Download and use
Sby Skills Guide Bot
DocumentationIntermediate
6/2/2026
Claude CodeCursor
#documentation#code-changes#readme#knowledge-base#sync

Recommended for

Claude CodeCursorAuto documentation

Automated summary

Updates all project documentation files after code changes.

Strengths

  • Automates the documentation update process after code changes.
  • Ensures consistency between English and Chinese README versions.
  • Automatically runs tests to verify changes.

Limitations

  • Requires specific files (KNOWLEDGE_BASE.md, README.md, README_ZH.md) to already exist.
  • Depends on sub-skills (update-knowledge-base, sync-readme) being available.
  • Does not cover automatically generated documentation (e.g., JSDoc, API docs).
When to use it

Use this skill after any changes that affect the UI, API, or project configuration.

When not to use it

Avoid using it for purely internal changes or minor fixes with no user-facing impact.

Security analysis

Safe
Quality score90/100

The skill only instructs to run documentation update skills and 'npm test', which are standard, safe operations for maintaining project docs. No destructive commands, exfiltration, or obfuscation.

No concerns found

How this analysis is made

Examples

Update docs after adding OpenCode support
Update all docs after adding OpenCode support
Update docs after CLI command change
Update documentation after modifying CLI commands

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

From the file to a first result

The download contains exactly the content displayed on this page. This copy may differ from the latest version in the source repository.

View the source and supporting files

This download contains SKILL.md only. Any scripts, references, templates and dependencies are not included. Get the required files from the source, preserving their directory structure, before continuing.

1. Download the file

Download SKILL.md

From the root of a test project, save the file as .skill-downloads/update-documentation-mmlj2p6y/SKILL.md, or use the command below. This folder is for inspecting the skill before installation.

Command for macOS/Linux or WSL: requires a POSIX shell and curl. On Windows without WSL, use the download button and create the folder manually.

mkdir -p '.skill-downloads/update-documentation-mmlj2p6y' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/update-documentation-mmlj2p6y/download' --output '.skill-downloads/update-documentation-mmlj2p6y/SKILL.md.part' && mv '.skill-downloads/update-documentation-mmlj2p6y/SKILL.md.part' '.skill-downloads/update-documentation-mmlj2p6y/SKILL.md'

2. Check prerequisites

Read SKILL.md before using it. If it references scripts or external services, inspect them and prepare the required access in your test environment.

No recognized prerequisites section in this file. This does not mean it is self-contained: libraries, tools and access requirements may be mentioned elsewhere in the content or source repository.

The platforms on this page are catalog indications. The paths below follow tool documentation; they do not prove this skill has been run in those tools. No minimum tool version is confirmed for this listing.

3. Load the skill

After inspection, copy the complete folder into your project using one of the commands below, then open a new tool session. The command stops if a folder with the same name already exists: compare the files before replacing it.

Claude Code
test -f '.skill-downloads/update-documentation-mmlj2p6y/SKILL.md' && test -s '.skill-downloads/update-documentation-mmlj2p6y/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/update-docs' && cp -R '.skill-downloads/update-documentation-mmlj2p6y' '.claude/skills/update-docs'

Cursor
test -f '.skill-downloads/update-documentation-mmlj2p6y/SKILL.md' && test -s '.skill-downloads/update-documentation-mmlj2p6y/SKILL.md' && mkdir -p '.cursor/skills' && test ! -e '.cursor/skills/update-docs' && cp -R '.skill-downloads/update-documentation-mmlj2p6y' '.cursor/skills/update-docs'

OpenSkills

OpenSkills must already be installed. The local install/read procedure is checked with OpenSkills 1.5.0, which requires Node.js ≥ 20.6.0. Catalog slugs are not resolved automatically.

Official OpenSkills installation
openskills install './.skill-downloads/update-documentation-mmlj2p6y'

openskills read 'update-documentation-mmlj2p6y'

Reading should display the installed file content and its base directory. It does not run the skill or install its dependencies.

For an agent that reads AGENTS.md, then sync the index. This command changes AGENTS.md: review the diff before using it.

openskills sync

Manual method or another tool: attach SKILL.md to a conversation, or open it in an agent that can read files. Include any required supporting resources. No universal folder is recognized by every tool.

4. Try a first task

Use a short, synthetic input: an API endpoint, a small document or an interface brief. In a new conversation, attach the file or give the agent its path, then adapt this request:

Read .skill-downloads/update-documentation-mmlj2p6y/SKILL.md and apply its instructions to this example: [describe a test input]. Identify any missing files, dependencies or access. Produce the result requested by the skill without inventing data or running unreviewed scripts.

Expected result: output matching the skill instructions, or a precise list of missing prerequisites. A read confirmation alone does not validate a first use. If an external resource is unavailable, that path remains untested.

Related skills

Supabase Docs Authoring

Documentation

Write, edit, and review Supabase documentation content including guides, tutorials, reference docs, and partials. Follow style guides and MDX/TOML validation rules.

Claude CodeintermediateSafe 108,544
Skills Guide Bot

Create Architecture Decision Record

Documentation

Create a new Architecture Decision Record with sequential numbering, register it in the AgentDB graph, and link related ADRs.

Claude CodeintermediateSafe 69,659
Skills Guide Bot

Plan update with deep research

Documentation

Updates a plan document by launching parallel subagents to analyze a topic across all compiler passes, then consolidates findings into the plan doc.

Claude CodeadvancedSafe 248,015
Skills Guide Bot