Notre avis
Met à jour la documentation (docstrings, fichiers *.md) pour qu'elle corresponde au code source modifié.
Points forts
- Vérifie la cohérence entre la signature et la docstring (paramètres, types, exceptions).
- Prend en charge les formats NumPy et Google.
- Gère la documentation bilingue (anglais/japonais) dans les répertoires dédiés.
Limites
- Ne rédige pas de documentation de A à Z ; nécessite un code source existant.
- Peut ne pas détecter les modifications sémantiques subtiles non reflétées dans la signature.
Quand vous avez modifié du code et que vous voulez être sûr que la documentation reste à jour.
Pour créer une documentation initiale d'un projet sans code source.
Analyse de sécurité
SûrThe 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.
Aucun point d'attention détecté
Exemples
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
Generateur de Documentation API
Documentation
Genere automatiquement de la documentation API OpenAPI/Swagger.
Rédacteur Technique
Documentation
Rédige de la documentation technique claire selon les meilleurs style guides.
Système de formulaires de documentation typés
Documentation
Utilisez la syntaxe `(doc ...)` pour ajouter des annotations typées, des descriptions, des tâches (todo) et d'autres métadonnées directement dans le code Scheme. Les annotations sont extractibles via des commandes comme lf-todo et lf-types, et s'intègrent au vérificateur de types, où les déclarations de type dans les doc prennent le pas sur l'inférence. Idéal pour documenter les fonctions, marquer des déprécations ou lister des améliorations localisées sans recourir à un système externe.