Conectar

Update Documentation

lbb00bylbb00
•
17
•
Gestión de Contenido

Synchronizes and updates project documentation, README files, and multi-language translations automatically after code changes.

The Update Documentation skill streamlines the maintenance of project manuals by analyzing recent git commits and code modifications to ensure documentation never falls behind. It intelligently updates the project's knowledge base, amends the primary README with new features or command changes, and synchronizes internationalized versions like README_ZH.md to maintain parity. By integrating a verification loop that runs tests and reviews diffs, this skill ensures that all user-facing documentation remains an accurate, high-quality reflection of the current codebase.

Características Principales

01Integrated verification step to run tests and review diffs before committing
02Dynamic README.md modification for new CLI commands or API changes
03Seamless KNOWLEDGE_BASE.md updates for architectural and feature tracking
0417 GitHub stars
05Automated git status analysis to identify necessary documentation updates
06Automatic synchronization of Chinese documentation (README_ZH.md) with English sources

Casos de Uso

01Ensuring project knowledge bases are current for AI subagents and team members
02Keeping multi-language README files perfectly aligned across a repository
03Maintaining documentation parity after adding new adapters or CLI commands
name description
update-docs
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