Our review
This skill updates documentation (docstrings and .md files) to reflect changes in the source code.
Strengths
- Ensures documentation accuracy
- Supports bilingual documentation (English and Japanese)
- Checks both docstrings and external documentation
- Integrates with build step for verification
Limitations
- Requires existing documentation format
- May not handle large-scale refactoring
- Relies on manual trigger or integration
Use this skill when modifying code that has corresponding documentation to keep them synchronized.
Do not use it for initial documentation creation or when the documentation format is non-standard.
Security analysis
SafeThe skill instructs reading source code and updating docstrings/documentation files. It does not invoke any executable tools, network calls, or destructive commands. There is no risk of code execution, data exfiltration, or safety bypass.
No concerns found
Examples
Update the docstrings in src/utils.py to match the new function signatures and parameters.Synchronize the README.md with the latest API changes in the codebase, including both English and Japanese versions.Check and update both English and Japanese documentation files under docs/reference/ for the new feature added in main.py.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.