docs-validator
Valider la qualité de la documentation
Les problèmes de qualité de la documentation gaspillent le temps des développeurs et frustrent les utilisateurs. Cette compétence analyse vos documents pour vérifier la complétude, les liens brisés, les erreurs de formatage et les problèmes de cohérence, puis propose des correctifs actionnables avec des recommandations priorisées.
下載技能 ZIP
在 Claude 中上傳
前往 設定 → 功能 → 技能 → 上傳技能
開啟並開始使用
測試它
正在使用「docs-validator」。 Validate the documentation
預期結果:
- Rapport de validation de la documentation
- Score global: 82/100 (Bon)
- Couverture: 91% des README des modules, 80% des guides utilisateurs
- Problèmes critiques: 2 (documentation du module misc manquante, lien externe brisé)
- Priorité principale: Créer source/misc/README.md pour documenter 82 classes
正在使用「docs-validator」。 Check for broken links
預期結果:
- 3 liens brisés trouvés:
- 1. docs/README.md:15 - [Setup](setup.md) - Fichier non trouvé
- 2. docs/user-guide/installation.md:45 - https://old-url.com/download - 404 Non trouvé
- 3. docs/api/reference.md:72 - [Auth](../auth/reference.md) - Ancre de section invalide
正在使用「docs-validator」。 Analyze module documentation coverage
預期結果:
- README des modules: 10/11 (91%)
- Manquant: source/misc/README.md (82 classes non documentées)
- Tous les autres modules ont une documentation complète
- Recommandé: Créer misc/README.md pour documenter 61% des classes non documentées
安全審計
安全This is a pure prompt-based skill with no executable code. The SKILL.md file contains only documentation validation guidelines and example prompts for an AI assistant. All 65 static findings are false positives: cryptographic algorithm detections are misidentified hash identifiers, external_commands are illustrative bash examples with hardcoded paths, and network/filesystem detections are benign markdown content. The skill-report.json explicitly marks risk_level as safe.
風險因素
📁 檔案系統存取 (2)
⚙️ 外部命令 (38)
品質評分
你能建構什麼
Audit de documentation avant publication
Exécutez un audit complet avant les publications pour vous assurer que la documentation répond aux normes de qualité et que toutes les fonctionnalités sont documentées
Révision des contributions de documentation
Vérifiez les nouvelles soumissions de documentation pour la complétude, la cohérence du formatage et les exemples de code fonctionnels avant la fusion
Surveillance continue de la qualité
Suivez la couverture de la documentation au fil du temps, identifiez les lacunes dans la documentation des modules et maintenez un style cohérent dans tous les documents
試試這些提示
Validez la documentation dans ce projet. Signalez le score global, mettez en évidence les 3 principaux problèmes et montrez le pourcentage de couverture pour les fichiers README des modules.
Vérifiez tous les documents pour les liens brisés. Listez chaque lien brisé avec son emplacement de fichier et son numéro de ligne, puis suggérez le chemin ou l'URL correct.
Exécutez un audit complet de la documentation. Vérifiez la complétude, l'exactitude, le formatage, les liens et la cohérence. Générez un rapport détaillé avec les niveaux de sévérité et les correctifs priorisés.
Analysez la couverture de la documentation des modules. Listez tous les modules, vérifiez la présence de fichiers README, signalez la documentation manquante et suggérez un ordre de priorité pour créer les documents manquants.
最佳實務
- Exécutez des vérifications de validation rapide avant chaque mise à jour de documentation pour détecter les problèmes tôt
- Effectuez des audits complets mensuellement et avant les publications majeures pour maintenir les normes de qualité
- Utilisez les recommandations priorisées pour vous concentrer d'abord sur les correctifs à fort impact
避免
- Sauter la validation de la documentation et se fier uniquement à la révision manuelle
- Ignorer les liens internes brisés qui confondent les utilisateurs naviguant dans la documentation
- Accepter une terminologie incohérente dans les différentes sections de documentation
常見問題
Quels formats de documentation cette compétence prend-elle en charge?
Cette compétence peut-elle corriger automatiquement les liens brisés?
Cette compétence fonctionne-t-elle avec les dépôts privés?
Combien de temps prend un audit complet de la documentation?
Puis-je intégrer cela dans les pipelines CI/CD?
Qu'est-ce qui différencie cette compétence des autres outils de documentation?
開發者詳情
授權
MIT
儲存庫
https://github.com/C0ntr0lledCha0s/logseq-template-graph/tree/main/.claude/skills/docs-validator引用
main
檔案結構
📄 SKILL.md