documentation-writer
Erstellen Sie professionelle technische Dokumentation
متاح أيضًا من: C0ntr0lledCha0s
Haben Sie Schwierigkeiten, klare, strukturierte Softwaredokumentation zu erstellen? Diese Skill wendet das bewährte Diátaxis-Framework an, um Tutorials, Anleitungen, Referenzdokumentationen und Erklärungen zu erstellen.
تنزيل ZIP المهارة
رفع في Claude
اذهب إلى Settings → Capabilities → Skills → Upload skill
فعّل وابدأ الاستخدام
اختبرها
استخدام "documentation-writer". Erstellen Sie eine Anleitung für die Einrichtung der Authentifizierung in einer Node.js Express-Anwendung unter Verwendung von JWT-Tokens.
النتيجة المتوقعة:
- # JWT-Authentifizierung in Express implementieren
- Voraussetzungen: Node.js installiert, grundlegende Express-Kenntnisse
- Schritt 1: Abhängigkeiten installieren (jsonwebtoken, bcrypt)
- Schritt 2: Endpunkt für Benutzerregistrierung mit Passwort-Hashing erstellen
- Schritt 3: Anmeldeendpunkt implementieren, der JWT-Tokens generiert
- Schritt 4: Authentifizierungs-Middleware erstellen, um Routen zu schützen
- Schritt 5: Den vollständigen Authentifizierungsablauf testen
استخدام "documentation-writer". Schreiben Sie Referenzdokumentation für einen REST-API-Endpunkt, der Benutzer erstellt.
النتيجة المتوقعة:
- # POST /api/users - Benutzer erstellen
- Beschreibung: Erstellt ein neues Benutzerkonto mit den bereitgestellten Informationen.
- Anfragekörper: { email: string, password: string, name: string }
- Antwort 201: { id: number, email: string, name: string, created_at: timestamp }
- Antwort 400: Validierungsfehlerdetails
- Antwort 409: E-Mail bereits vorhanden
التدقيق الأمني
آمنStatic analysis detected 5 pattern matches that were evaluated as false positives. The network URL at line 9 is a reference link to the Diátaxis framework website, not an actual network call. The cryptographic algorithm warnings at lines 3, 23, 24, and 37 are incorrect matches on documentation text. This skill explicitly restricts external website access and contains no file system operations, command execution, or data exfiltration patterns.
درجة الجودة
ماذا يمكنك بناءه
Erstellung von API-Dokumentation
Erstellen Sie umfassende API-Referenzdokumentationen einschließlich Endpunktbeschreibungen, Anfrage/Antwort-Schemata und Nutzungsbeispiele für Entwicklerteams.
Entwicklung von Onboarding-Tutorials
Erstellen Sie lernorientierte Tutorials, die neue Teammitglieder oder Benutzer durch Einrichtung, Konfiguration und erste erfolgreiche Projektergebnisse führen.
Bibliothek für Anleitungen
Erstellen Sie eine Sammlung von problemlösenden Anleitungen für häufige Benutzeraufgaben, Fehlerbehebungsszenarien und Integrationsworkflows.
جرّب هذه الموجهات
Erstellen Sie ein Referenzdokument für [Komponente/API/Feature]. Einschließen: Zweck, Schlüsselkonzepte, Parameter/Optionen, Rückgabewerte und Codebeispiele. Zielgruppe: [Zielgruppe beschreiben].
Schreiben Sie eine Anleitung für die Ausführung von [spezifische Aufgabe]. Strukturieren Sie als: Voraussetzungen, Schritt-für-Schritt-Anweisungen mit Codebeispielen, erwartete Ergebnisse und Fehlerbehebungstipps. Kompetenzstufe der Zielgruppe: [Anfänger/Intermediär/Fortgeschritten].
Erklären Sie [technisches Konzept] ausführlich. Decken Sie ab: Was es ist, warum es wichtig ist, wie es intern funktioniert, häufige Missverständnisse und wann es verwendet werden sollte. Einschließen Analogien zur Verdeutlichung. Ziel: [Zielgruppenbeschreibung].
Entwerfen Sie eine Tutorialreihe, die [Fähigkeit/Thema] von Anfänger bis kompetent lehrt. Erstellen Sie 5 fortschreitende Lektionen mit praktischen Übungen, jede aufbauend auf der vorherigen. Einschließen Lernziele und Erfolgskriterien für jede Lektion.
أفضل الممارسات
- Klären Sie vor dem Schreiben immer den Dokumenttyp und die Zielgruppe, um angemessenen Tonfall und Struktur zu gewährleisten
- Schlagen Sie zuerst eine Gliederung vor und warten Sie auf Genehmigung, bevor Sie vollständige Inhalte generieren, um strukturelle Probleme frühzeitig zu erkennen
- Fügen Sie praktische Codebeispiele zu jedem technischen Konzept hinzu, um das Verständnis und die Merkfähigkeit zu verbessern
تجنب
- Das Schreiben von Dokumentation ohne vorheriges Verständnis des Benutzerziels führt zu irrelevantern oder unfokussierten Inhalten
- Das Mischen von Dokumenttypen wie das Kombinieren von Tutorial-Schritten mit Referenzspezifikationen verwirrt die Leser
- Das Erstellen zu langer Dokumente ohne klare Abschnittsunterbrechungen verringert die Lesbarkeit und Auffindbarkeit