Habilidades post-impl-docs
📝

post-impl-docs

Riesgo bajo 📁 Acceso al sistema de archivos

Maintenir la documentation synchronisée avec le code

La documentation se désynchronise souvent des modifications de code. Cette compétence met automatiquement à jour le README, le CHANGELOG, le dossier docs et les docstrings pour refléter les modifications implémentées.

Soporta: Claude Codex Code(CC)
⚠️ 67 Deficiente
1

Descargar el ZIP de la skill

2

Subir en Claude

Ve a Configuración → Capacidades → Skills → Subir skill

3

Activa y empieza a usar

Pruébalo

Usando "post-impl-docs". Run post-impl-docs to update documentation after implementing a new user authentication feature

Resultado esperado:

Documentation updated successfully:

README.md:
- Added "User Authentication" to Features section
- Added `authenticate_user()` to API section

CHANGELOG.md:
- Added `feat:` entry for user authentication endpoint

docstrings:
- Updated 3 function docstrings

Files modified: 5

Usando "post-impl-docs". Update documentation for a bug fix that changes error handling behavior

Resultado esperado:

Documentation update summary:

CHANGELOG.md:
- Added `fix:` entry for error handling improvement

docstrings:
- Updated `ValueError` raises documentation in 2 functions

README.md: No changes needed (internal fix)
docs/: No references affected

Auditoría de seguridad

Riesgo bajo
v6 • 1/21/2026

Documentation skill containing cookbook reference material. All static findings are false positives - the skill contains markdown documentation with git command examples, changelog format references, and placeholder code blocks that triggered pattern matching but pose no security risk.

5
Archivos escaneados
3,786
Líneas analizadas
1
hallazgos
6
Auditorías totales

Factores de riesgo

📁 Acceso al sistema de archivos (4)
SKILL.md:1-297 cookbook/changelog-formats.md:1-255 cookbook/docstring-standards.md:1-345 cookbook/readme-updates.md:1-271
Auditado por: claude Ver historial de auditorías →

Puntuación de calidad

38
Arquitectura
100
Mantenibilidad
87
Contenido
19
Comunidad
90
Seguridad
83
Cumplimiento de la especificación

Lo que puedes crear

Maintenir des CHANGELOGs précis

Après l'implémentation de fonctionnalités ou de correctifs, ajouter automatiquement des entrées de changelog correctement formatées selon les normes de commit conventionnelles.

Garder le README synchronisé

Mettre à jour les listes de fonctionnalités, les sections API et les exemples d'utilisation dans README.md lorsque nouveau code est ajouté au projet.

Mettre à jour la documentation inline

Synchroniser les docstrings avec les modifications de code pour garantir que les descriptions de fonctions, paramètres et valeurs de retour restent précises.

Prueba estos prompts

Mise à jour de documentation basique 
Mettre à jour la documentation après l'implémentation récente. Analyser le git diff pour comprendre ce qui a changé. Mettre à jour README.md avec les nouvelles fonctionnalités, ajouter les entrées de changelog dans CHANGELOG.md, et mettre à jour les docstrings des fonctions modifiées.
Documentation des breaking changes 
Documenter un breaking change. Mettre à jour les guides de migration du README, ajouter une notice de breaking change dans le CHANGELOG, mettre à jour tous les docstrings affectés, et signaler la documentation dans le dossier docs/ pour révision.
Documentation des nouvelles API 
Ajouter une documentation pour les nouveaux endpoints API. Mettre à jour la section API du README, ajouter des exemples d'utilisation, créer des docstrings pour les nouvelles fonctions, et ajouter l'entrée correspondante dans le CHANGELOG.
Audit complet de la documentation 
Effectuer une révision complète de la documentation. Analyser tous les fichiers modifiés, mettre à jour les références aux symboles modifiés dans docs/, vérifier l'exactitude des docstrings, et générer un rapport complet de mise à jour de la documentation.

Mejores prácticas

  • Exécuter cette compétence après avoir terminé l'implémentation mais avant de commiter pour s'assurer que la documentation est à jour
  • Configurer la variable CHANGELOG_FORMAT pour correspondre au style de changelog de votre projet (conventional, keep-a-changelog ou simple)
  • Définir COMMIT_DOCS=true pour commiter automatiquement les modifications de documentation avec le code

Evitar

  • Exécuter les mises à jour de documentation sans analyser d'abord les véritables modifications de code
  • Ajouter des entrées CHANGELOG pour des modifications triviales comme les corrections de fautes de frappe
  • Mettre à jour les docstrings sans vérifier que le comportement de la fonction a effectivement changé

Preguntas frecuentes

Cette compétence crée-t-elle de nouveaux fichiers de documentation ?
Non. Cette compétence met à jour la documentation existante (README, CHANGELOG, fichiers docs/, docstrings). Elle ne génère pas de nouvelle documentation à partir de zéro.
Quels formats de changelog sont supportés ?
Trois formats sont supportés : conventional (style Angular), keep-a-changelog (standard Keep a Changelog) et simple (liste markdown basique).
Commite-t-elle les modifications automatiquement ?
Définir COMMIT_DOCS=true pour commiter automatiquement les modifications de documentation. Par défaut à true. Les modifications sont commitées séparément du code.
Que se passe-t-il s'il n'y a pas de modifications de code ?
La compétence analyse le git diff. Si aucune modification n'est détectée, elle retourne un statut no_changes indiquant aucun impact sur la documentation.
Peut-elle mettre à jour la documentation pour n'importe quel langage de programmation ?
Oui. La compétence fonctionne avec n'importe quel langage. Les templates de docstring pour Python et TypeScript/JavaScript sont inclus dans le cookbook.
Comment sait-elle quelle documentation mettre à jour ?
Elle scanne le dossier docs/ avec grep pour trouver les références aux fonctions/classes modifiées, puis met à jour uniquement la documentation affectée.

Detalles del desarrollador

Licencia

MIT

Repositorio

https://github.com/Consiliency/treesitter-chunker/tree/main/.ai-dev-kit/skills/post-impl-docs

Ref.

main

Estructura de archivos

📁 cookbook/

📄 changelog-formats.md

📄 docstring-standards.md

📄 readme-updates.md

📄 SKILL.md