Notre avis
Cette compétence met à jour la documentation (docstrings et fichiers .md) pour refléter les changements dans le code source.
Points forts
- Assure l'exactitude de la documentation
- Prend en charge la documentation bilingue (anglais et japonais)
- Vérifie à la fois les docstrings et la documentation externe
- S'intègre avec l'étape de construction pour la vérification
Limites
- Nécessite un format de documentation existant
- Peut ne pas gérer un refactoring à grande échelle
- Dépend d'un déclencheur manuel ou d'une intégration
Utilisez cette compétence lorsque vous modifiez du code qui a une documentation correspondante pour les maintenir synchronisées.
Ne l'utilisez pas pour la création initiale de documentation ou lorsque le format de documentation n'est pas standard.
Analyse de sécurité
SûrThe 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.
Aucun point d'attention détecté
Exemples
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
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.
Maintenance de la documentation
Documentation
Cette compétence propose un workflow structuré pour mettre à jour la documentation du projet, notamment CLAUDE.md, README et CHANGELOG. Elle guide à travers des phases comme l'inventaire des documents existants, l'analyse de l'historique Git pour identifier les changements nécessaires, l'optimisation pour la lisibilité par l'IA et la cohérence entre les documents. À utiliser lors de la synchronisation de la documentation avec les modifications de code ou pour améliorer l'efficacité de la documentation pour les agents de codage IA.