Notre avis
Cette compétence synchronise la documentation (docstrings et fichiers Markdown) avec le code source.
Points forts
- Mise à jour des docstrings selon le style du projet
- Gestion bilingue (anglais et japonais) des fichiers de documentation
- Vérification syntaxique via la compétence build_docs
Limites
- Nécessite que le code source soit déjà commenté
- La détection des changements peut être partielle sans exécution
- Ne corrige pas les incohérences sémantiques dans la documentation
Idéal après une modification de code pour maintenir la cohérence entre code et documentation.
Évitez si la documentation est générée automatiquement par d'autres outils ou si le projet n'a pas de documentation bilingue.
Analyse de sécurité
SûrThe 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.
Aucun point d'attention détecté
Exemples
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
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.