Synchronizes project documentation and user guides automatically with the latest source code signatures and docstrings.
The update-docs skill ensures that your project's README, architecture notes (CLAUDE.md), and interactive notebooks remain perfectly in sync with your codebase. By analyzing public APIs, docstrings, and type signatures, it performs surgical edits to documentation files to reflect new features, refactors, or removals without altering the original style or formatting. This eliminates the manual effort of maintaining technical documentation and prevents the common problem of stale or inaccurate user guides and API references.
主要功能
01Surgical updates to README.md and CLAUDE.md preserving existing styles
02Automatic API extraction from source code docstrings and signatures
031 GitHub stars
04Intelligent diffing to update only stale sections without full rewrites
05Cross-file consistency verification for function descriptions and import paths
06Synchronizes Jupyter Notebook (.ipynb) user guides with current module maps
使用场景
01Refreshing technical documentation after a major feature addition or code refactor
02Synchronizing architecture invariants in CLAUDE.md with the actual project structure
03Ensuring user guides and READMEs are accurate and up-to-date before a version release
