Does it document private functions?

No, the skill is designed to only document public APIs, intentionally ignoring private helper functions and internal symbols starting with underscores.

Does this skill overwrite my entire README?

No, it performs surgical edits to specific sections to preserve your existing style, tone, and manually written content while only updating stale technical details.

Can it update Jupyter Notebooks?

Yes, it specifically targets .ipynb guide files to update API examples and module maps while keeping markdown cells and existing output cells intact.

When should I run the update-docs skill?

It is best used after significant code changes, before a release, or whenever you notice that your documentation no longer matches the current state of the code.

Documentation Sync & Update

Name: Documentation Sync & Update
Author: laceto

bylaceto

•

Gestión de Contenido

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.

Características Principales

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

Casos de Uso

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

Características Principales

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

Casos de Uso

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