Our review
This skill synchronizes documentation (docstrings and Markdown files) with the actual source code.
Strengths
- Updates docstrings to match project style
- Handles bilingual (English and Japanese) documentation files
- Verifies syntax via build_docs skill
Limitations
- Requires existing docstrings to update
- Change detection may be incomplete without execution
- Does not fix semantic inconsistencies in documentation
Best after code modifications to keep documentation in sync.
Avoid if documentation is auto-generated by other tools or if the project lacks bilingual docs.
Security analysis
SafeThe skill only reads and writes documentation files (docstrings, markdown). It does not execute system commands, access networks, or perform destructive operations. No security risks are introduced.
No concerns found
Examples
Update docstrings for all changed functions in src/utils.py to reflect new parameter names and return types, using NumPy style.I added a new function `get_user` in users.py. Please update the README and docs/reference/en/ and docs/reference/ja/ to include this new function in the API reference section.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.
Typed Documentation Forms System
Documentation
Add typed comments, documentation, todos, and metadata to Scheme code using `(doc ...)` forms. Doc annotations are authoritative for type inference, extracted by search commands (lf-todo, lf-types), and integrated with the type checker and LSP. Useful for annotating functions, marking deprecations, or tracking localized improvements alongside the code.