docs-validator
Dokumentationsqualität validieren
Probleme mit der Dokumentationsqualität verschwenden Entwicklerzeit und frustrieren Benutzer. Dieser Skill scannt Ihre Dokumente auf Vollständigkeit, defekte Links, Formatierungsfehler und Konsistenzprobleme und bietet dann umsetzbare Lösungen mit priorisierten Empfehlungen.
Baixar o ZIP da skill
Upload no Claude
Vá em Configurações → Capacidades → Skills → Upload skill
Ative e comece a usar
Testar
A utilizar "docs-validator". Validate the documentation
Resultado esperado:
- Dokumentationsvalidierungsbericht
- Gesamtbewertung: 82/100 (Gut)
- Abdeckung: 91% Modul-READMEs, 80% Benutzerhandbücher
- Kritische Probleme: 2 (fehlende misc-Module-Dokumentation, defekter externer Link)
- Höchste Priorität: Erstellen Sie source/misc/README.md, um 82 Klassen zu dokumentieren
A utilizar "docs-validator". Check for broken links
Resultado esperado:
- 3 defekte Links gefunden:
- 1. docs/README.md:15 - [Setup](setup.md) - Datei nicht gefunden
- 2. docs/user-guide/installation.md:45 - https://old-url.com/download - 404 Nicht gefunden
- 3. docs/api/reference.md:72 - [Auth](../auth/reference.md) - Sektionsanker ungültig
A utilizar "docs-validator". Analyze module documentation coverage
Resultado esperado:
- Modul-READMEs: 10/11 (91%)
- Fehlend: source/misc/README.md (82 Klassen undokumentiert)
- Alle anderen Module haben vollständige Dokumentation
- Empfohlen: Erstellen Sie misc/README.md, um 61% der undokumentierten Klassen zu dokumentieren
Auditoria de Segurança
SeguroThis 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.
Fatores de risco
🌐 Acesso à rede (5)
📁 Acesso ao sistema de arquivos (2)
⚙️ Comandos externos (38)
Pontuação de qualidade
O Que Você Pode Construir
Dokumentations-Audit vor der Veröffentlichung
Führen Sie ein umfassendes Audit vor Veröffentlichungen durch, um sicherzustellen, dass die Dokumentation den Qualitätsstandards entspricht und alle Funktionen dokumentiert sind
Überprüfung von Dokumentationsbeiträgen
Prüfen Sie neue Dokumentationseinreichungen auf Vollständigkeit, Formatierungskonsistenz und funktionierende Codebeispiele vor dem Zusammenführen
Laufende Qualitätsüberwachung
Verfolgen Sie die Dokumentationsabdeckung im Laufe der Zeit, identifizieren Sie Lücken in der Moduldokumentation und wahren Sie einen konsistenten Stil in allen Dokumenten
Tente Estes Prompts
Validieren Sie die Dokumentation in diesem Projekt. Melden Sie die Gesamtbewertung, heben Sie die Top-3-Probleme hervor und zeigen Sie die Abdeckungsprozentsatz für Modul-READMEs.
Prüfen Sie alle Dokumentationen auf defekte Links. Listen Sie jeden defekten Link mit seinem Dateispeicherort und der Zeilennummer auf und schlagen Sie dann den korrekten Pfad oder die korrekte URL vor.
Führen Sie ein vollständiges Dokumentationsaudit durch. Prüfen Sie Vollständigkeit, Genauigkeit, Formatierung, Links und Konsistenz. Erstellen Sie einen detaillierten Bericht mit Schweregraden und priorisierten Korrekturen.
Analysieren Sie die Moduldokumentationsabdeckung. Listen Sie alle Module auf, prüfen Sie auf README-Dateien, melden Sie fehlende Dokumentation und schlagen Sie eine Prioritätsreihenfolge für das Erstellen fehlender Dokumente vor.
Melhores Práticas
- Führen Sie schnelle Validierungsprüfungen vor jeder Dokumentationsaktualisierung durch, um Probleme frühzeitig zu erkennen
- Führen Sie monatlich vollständige Audits und vor größeren Veröffentlichungen durch, um Qualitätsstandards zu wahren
- Verwenden Sie die priorisierten Empfehlungen, um sich zunächst auf hochwirksame Korrekturen zu konzentrieren
Evitar
- Dokumentationsvalidierung überspringen und sich nur auf manuelle Überprüfung verlassen
- Ignorieren defekter interner Links, die Benutzer bei der Navigation in der Dokumentation verwirren
- Akzeptieren inkonsistenter Terminologie über verschiedene Dokumentationsabschnitte hinweg
Perguntas Frequentes
Welche Dokumentationsformate unterstützt dieser Skill?
Kann dieser Skill defekte Links automatisch beheben?
Funktioniert dieser Skill mit privaten Repositories?
Wie lange dauert ein vollständiges Dokumentationsaudit?
Kann ich dies in CI/CD-Pipelines integrieren?
Was unterscheidet dies von anderen Dokumentations-Tools?
Detalhes do Desenvolvedor
Autor
C0ntr0lledCha0sLicença
MIT
Repositório
https://github.com/C0ntr0lledCha0s/logseq-template-graph/tree/main/.claude/skills/docs-validatorReferência
main
Estrutura de arquivos
📄 SKILL.md