Our review
This skill updates documentation (docstrings and .md files) to match code changes.
Strengths
- Handles both English and Japanese documentation simultaneously.
- Supports NumPy and Google style docstrings.
- Verifies parameter, return type, and exception consistency.
Limitations
- Requires initial setup of documentation formats.
- Does not automatically detect code changes; user must specify them.
When you have modified code and need to synchronize the corresponding documentation across multiple languages.
When generating brand new documentation from scratch or for purely conceptual files.
Security analysis
SafeThe skill only instructs reading and writing documentation files; no destructive commands, network activity, or obfuscated code are present.
No concerns found
Examples
Update the docstring of function 'calculate_interest' to include the new 'rate' parameter and its type, following the NumPy style used in the project.I changed the 'get_user' method signature. Please update both docs/reference/en/api.rst and docs/reference/ja/api.rst to reflect the new parameters.name: sync_docs description: ソースコードの実装に合わせてドキュメント (docstring, *.md) を更新する
Sync Documentation
This skill ensures that the documentation is in sync with the actual code implementation.
Instructions
-
Update Docstrings:
- Read the target source code.
- Check if parameters, return types, and exceptions in the docstring match the signature and logic.
- Update the docstring using the standard format (NumPy or Google style, matching the project).
-
Update Documentation Files:
- Check
docs/orREADME.mdfor references to the changed code. - Crucial: Check both English (
docs/reference/en/) and Japanese (docs/reference/ja/) documentation directories. - Update tutorials or API references if the usage has changed.
- If a new feature was added, ensure it is mentioned in the appropriate section in both languages.
- Check
-
Verify:
- If possible, run the
build_docsskill to ensure no syntax errors were introduced in ReStructuredText or Markdown.
- If possible, run the
API Documentation Generator
Documentation
Automatically generates OpenAPI/Swagger API documentation.
Technical Writer
Documentation
Writes clear technical documentation following top style guides.
Documentation Maintenance
Documentation
This skill provides a structured workflow for updating project documentation including CLAUDE.md, README, and CHANGELOG. It walks through phases like inventorying existing docs, analyzing git history for needed changes, optimizing for AI readability, and ensuring cross-document consistency. Use it when synchronizing documentation with code changes or improving documentation effectiveness for AI coding agents.