documentation
Dokumentationsstandards durchsetzen
こちらからも入手できます: Joseph OBrien,Joseph OBrien,BfdCampos,sickn33,CrazySwami
Die Verwaltung von Dokumentation im großen Maßstab führt zu doppelten Inhalten und inkonsistenten Strukturen. Diese Skill bietet Werkzeuge zur Bearbeitung auf Abschnittsebene, Vorlagen und Workflows, um eine saubere, DRY-konforme Dokumentation zu pflegen, die mit dem Code synchron bleibt.
スキルZIPをダウンロード
Claudeでアップロード
設定 → 機能 → スキル → スキルをアップロードへ移動
オンにして利用開始
テストする
「documentation」を使用しています。 Dokumentation für einen neuen Einstellungsbildschirm erstellen
期待される結果:
- Checking for existing documentation about 'Settings'...
- Creating directory: docs/screens/settings
- Using template: assets/templates/screen-readme.md
- Using template: assets/templates/screen-technical.md
- Validating against: references/rules.md
「documentation」を使用しています。 Doppelte Dokumentation über Benutzerauthentifizierung finden
期待される結果:
- Searching docs/ for 'authentication'...
- Found duplicate sections in docs/architecture/security.md and docs/guides/auth.md
- Recommendation: Consolidate into docs/architecture/authentication.md
「documentation」を使用しています。 Dokumentationsqualität für den Home-Bildschirm prüfen
期待される結果:
- docs/screens/home/README.md: 245 lines - OK
- docs/screens/home/technical.md: 380 lines - OK
- docs/screens/home/features.md: 89 lines - OK
- All files pass validation: DRY principle, code references, size limits
セキュリティ監査
安全All 805 static findings are false positives. The analyzer flagged markdown documentation showing example shell commands and technical keywords as security risks. Actual shell scripts are legitimate documentation utilities using standard Unix tools.
リスク要因
品質スコア
作れるもの
Neue Dokumentation standardisieren
Konsistente Vorlagen und Struktur anwenden, wenn neue Feature- oder Bildschirmdokumentation hinzugefügt wird.
Duplikate finden und beheben
Redundante Inhalte in der Dokumentation erkennen und in einzelne autoritative Quellen konsolidieren.
Dokumentation im großen Maßstab pflegen
Größenbeschränkungen, Code-Referenzen und DRY-Prinzipien in wachsenden Codebasen durchsetzen.
これらのプロンプトを試す
Create documentation for the new {screen-name} screen following the project templates. Check for existing docs first.Find all documentation related to {feature-name} and update the affected sections to match the code changes.Search for existing documentation about {topic}. If duplicates exist, consolidate them instead of creating new files.Check docs/screens/{screen-name}/README.md line count. If over 450 lines, split into focused sub-files.ベストプラクティス
- Immer nach vorhandener Dokumentation suchen, bevor neue Dateien erstellt werden
- Skripte auf Abschnittsebene verwenden, um die Kontextnutzung bei gezielten Aktualisierungen zu minimieren
- Jede neue oder geänderte Datei vor dem Commit gegen references/rules.md validieren
回避
- Doppelte Dokumentation erstellen, anstatt vorhandene Dateien zu aktualisieren
- Dateien mit über 500 Zeilen belassen, ohne sie in fokussierte Unterdateien aufzuteilen
- Datei:Zeilen-Referenzen weglassen, wenn Code-Verhalten dokumentiert wird