documentation
Erstellen professioneller API-Dokumentation und technischer Anleitungen
Également disponible depuis: BfdCampos,CrazySwami,Joseph OBrien,DaoThiHuong2111,sickn33
Das Erstellen qualitativ hochwertiger Dokumentation erfordert erheblichen Aufwand und technisches Fachwissen. Diese Fähigkeit bietet bewährte Vorlagen, Muster und Best Practices für die Erstellung von API-Dokumentation, Changelogs, Migrationsanleitungen, Architecture Decision Records und technischer Dokumentation, die Entwickler gerne verwenden.
Télécharger le ZIP du skill
Importer dans Claude
Allez dans Paramètres → Capacités → Skills → Importer un skill
Activez et commencez à utiliser
Tester
Utilisation de "documentation". Create a changelog for these commits: 'feat: add user authentication', 'fix: resolve login timeout bug', 'feat: add password reset flow', 'perf: improve database query performance'
Résultat attendu:
- **Neue Funktionen**
- - Benutzer-Authentifizierungssystem mit sicherer Anmeldung und Session-Verwaltung
- - Passwort-Reset-Flow zur Kontowiederherstellung
- **Bug-Fixes**
- - Timeout-Problem beim Anmelden behoben
- **Verbesserungen**
- - Schnellere Datenbankabfragen für verbesserte Antwortzeiten
Audit de sécurité
SûrPure documentation skill containing only markdown templates and best practice guidelines. No executable code, network calls, file system access, environment variable reads, or command execution. Contains only static documentation content for API docs, technical writing patterns, and documentation templates.
Score de qualité
Ce que vous pouvez construire
API-Dokumentation
Erstellen von OpenAPI-Spezifikationen, SDK-Dokumentation und interaktiven API-Anleitungen mit Beispielen in mehreren Sprachen
Benutzeranleitungen und Handbücher
Schreiben klarer Benutzeranleitungen, Tutorials und README-Dateien nach etablierten Mustern für technisches Schreiben
Architektur-Dokumentation
Dokumentieren von Designentscheidungen, Erstellen von ADRs und Erstellen von technischen Designspezifikationen für Stakeholder
Essayez ces prompts
Erstellen Sie eine OpenAPI 3.0-Spezifikation für die folgenden REST-API-Endpunkte: [list endpoints with methods and descriptions]
Erstellen Sie ein benutzerfreundliches Changelog aus diesen Git-Commits: [paste commit messages]. Gruppieren Sie Änderungen nach Kategorien: Features, Verbesserungen, Bug-Fixes und Breaking Changes.
Erstellen Sie eine Migrationsanleitung für das Upgrade von Version [old] auf [new]. Fügen Sie Breaking Changes, Codebeispiele vorher und nachher sowie schrittweise Upgrade-Anweisungen ein.
Erstellen Sie einen Architecture Decision Record für [decision topic]. Fügen Sie Kontext, Problemstellung, betrachtete Optionen, gewählte Lösung und erwartete Konsequenzen ein.
Bonnes pratiques
- Fügen Sie echte funktionierende Codebeispiele ein, keine Platzhalter, um Benutzern das Verständnis der Implementierung zu erleichtern
- Dokumentieren Sie Fehlerfälle und Antworten neben erfolgreichen Szenarien für vollständige API-Abdeckung
- Strukturieren Sie die Dokumentation mit klarer Hierarchie unter Verwendung von Inhaltsverzeichnissen und Querverweisen
Éviter
- Verwenden von Fachjargon ohne Erklärung, wenn für allgemeine Benutzer geschrieben wird
- Schreiben von Dokumentation nach Abschluss des Codes anstatt während der Entwicklung
- Einschließen interner Refactoring-Commits in benutzerorientierte Changelogs