Our review
Updates documentation (docstrings, *.md files) to reflect changes in source code.
Strengths
- Checks parameter, return type, and exception consistency between code and docstrings.
- Supports NumPy and Google docstring styles.
- Handles bilingual documentation (English/Japanese) in dedicated directories.
Limitations
- Does not write documentation from scratch; requires existing source code.
- May miss subtle semantic changes that are not reflected in the signature.
When you have modified code and want to ensure documentation stays in sync.
To create initial documentation for a project with no source code.
Security analysis
SafeThe skill only involves reading and editing documentation files; no tools or command execution are declared, so there is no risk of destructive or exfiltrating actions.
No concerns found
Examples
Please sync the documentation for the recently changed functions in src/utils.py. Update docstrings to match new parameters and return types using NumPy style, and check both English and Japanese docs/ directories.I added a new function `generate_report` in src/report.py. Please update the docstring (Google style) and ensure it's mentioned in README.md and the API reference in docs/reference/en/ and docs/reference/ja/.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.