Notre avis
Crée et maintient une documentation standardisée avec des modèles pour différents types de documents.
Points forts
- Impose une structure cohérente.
- Fournit des modèles pour les types de documents courants.
- Inclut la validation des en-têtes.
- S'intègre au flux de travail du projet.
Limites
- Dépend de normes définies par l'utilisateur.
- Peut ne pas couvrir tous les besoins documentaires.
- Nécessite une invocation manuelle.
Lorsque vous démarrez un nouveau projet ou devez maintenir une documentation cohérente au sein d'une équipe.
Pour une documentation très dynamique nécessitant des modifications non standard fréquentes ou lorsqu'un outil de documentation dédié est déjà utilisé.
Analyse de sécurité
SûrThe skill only uses file manipulation tools (Read, Write, Edit, Glob, Grep) for documentation tasks. There are no destructive commands, network access, or obfuscated payloads. No security risks are introduced by the skill itself.
Aucun point d'attention détecté
Exemples
/docs init/docs new feature/docs validatename: docs description: Documentation system with standards and templates user-invocable: true allowed-tools: Read, Write, Edit, Glob, Grep
Documentation Skill
Create and maintain standardized documentation.
Commands
/docs init- Initialize docs structure/docs new [type]- Create new document/docs status- Show docs status/docs validate- Validate headers
Document Types
| Type | Folder | Purpose | |------|--------|---------| | feature | features/ | Feature specs | | arch | architecture/ | Architecture docs | | changelog | changelog/ | Progress tracking | | roadmap | roadmap/ | Planning | | guide | guides/ | How-to guides | | todo | todo/ | Task tracking |
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.