Notre avis
Valide la documentation du projet en vérifiant les métadonnées, les sections obligatoires, les références croisées et la fraîcheur, avec un mode approfondi optionnel qui détecte également les conflits de version, assure la cohérence mémoire-doc, valide la structure ADR et vérifie l'exhaustivité des modules.
Points forts
- Détecte les problèmes structurels et les incohérences dans la documentation
- Propose deux niveaux de validation (standard et approfondi) selon les besoins
- Peut corriger automatiquement les erreurs identifiées après approbation
- Intègre des vérifications avancées comme la cohérence avec la mémoire et la structure ADR
Limites
- Dépend des outils MAGS et de la structure de projet spécifique
- Le mode approfondi peut être plus lent sur les grands projets
- Ne vérifie pas l'exactitude factuelle ou la qualité rédactionnelle du contenu
Utilisez cette compétence lorsque vous souhaitez vous assurer que la documentation du projet respecte les normes définies et est à jour avant une livraison ou une revue.
Évitez de l'utiliser pour de l'écriture ad-hoc ou lorsque la documentation ne suit pas encore un schéma de validation défini.
Analyse de sécurité
SûrThe skill uses only MCP documentation tools (validate_docs, get_doc, update_doc) and asks for user confirmation before modifying documents. It does not execute shell commands, access external networks, or handle sensitive data.
Aucun point d'attention détecté
Exemples
/mags-docs-validatename: mags-docs-validate description: Validate project documentation version: 1.0.0 user-invocable: true allowed-tools:
- mcp__mags_mags__mags_validate_docs
- mcp__mags_mags__mags_get_doc
- mcp__mags_mags__mags_update_doc
MAGS Docs Validate
Run validation checks on all project documents.
Usage
/mags-docs-validate
Steps
-
Ask the user: "Standard validation or deep validation?"
- Standard — checks frontmatter, required sections, cross-references, freshness
- Deep — all standard checks plus: version conflict detection, memory-doc consistency, ADR structure validation, and module completeness checks
If deep: call
mags_validate_docswithdeep: true. If standard (or no preference): callmags_validate_docswith default parameters. -
Display results grouped by severity:
== Document Validation == Errors (must fix): - docs/architecture/overview.md: Missing required section "Tech Stack" - docs/rules/backend.md: Broken internal link to ../api/auth.md Warnings (should fix): - docs/modules/auth.md: No code examples found - docs/changelog/changes.md: Last updated over 30 days ago Passed: <N>/<total> documents are healthy -
If there are errors, ask: "Would you like me to fix the errors?"
-
If yes, read each problematic doc with
mags_get_doc, fix the issues, and callmags_update_doc.
Related commands:
| Command | Description |
|---------|-------------|
| /mags-docs | List all project documents |
| /mags-docs-search <query> | Search across all documents |
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.
Architecte de Documentation Technique
Documentation
Analyse un code source existant pour produire une documentation technique complète (10 à 100+ pages), inclant des vues d'architecture, des décisions de conception et des guides de dépannage. Idéal pour la documentation système, les guides d'architecture ou les plongées techniques.