Notre avis
Cette compétence met à jour la documentation (docstrings et fichiers .md) pour refléter les modifications du code source.
Points forts
- Gère simultanément les documents en anglais et en japonais.
- Prend en charge les formats de docstring NumPy et Google.
- Vérifie la cohérence des paramètres, des types et des exceptions.
Limites
- Nécessite une configuration initiale des formats de documentation.
- Ne détecte pas automatiquement les modifications du code, l'utilisateur doit les préciser.
Lorsque vous modifiez le code et devez synchroniser la documentation associée dans plusieurs langues.
Pour générer une nouvelle documentation à partir de zéro ou pour des fichiers purement conceptuels.
Analyse de sécurité
SûrThe skill only instructs reading and writing documentation files; no destructive commands, network activity, or obfuscated code are present.
Aucun point d'attention détecté
Exemples
Update the docstring of function 'calculate_interest' to include the new 'rate' parameter and its type, following the NumPy style used in the project.I changed the 'get_user' method signature. Please update both docs/reference/en/api.rst and docs/reference/ja/api.rst to reflect the new parameters.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.