Reference Builder
Umfassende API- und technische Dokumentation erstellen
Das manuelle Erstellen von umfassender technischer Dokumentation ist zeitaufwändig und fehleranfällig. Dieser Skill automatisiert die Generierung vollständiger Referenzmaterialien mit konsistenter Formatierung und detaillierter Parameterabdeckung.
Die Skill-ZIP herunterladen
In Claude hochladen
Gehe zu Einstellungen → Fähigkeiten → Skills → Skill hochladen
Einschalten und loslegen
Teste es
Verwendung von "Reference Builder". Document a REST API endpoint: POST /api/users with parameters: name (string, required), email (string, required), age (integer, optional)
Erwartetes Ergebnis:
- ### POST /api/users
- **Description**: Creates a new user account in the system.
- **Parameters**:
- - `name` (string, required): User's full name, 2-100 characters
- - `email` (string, required): Valid email address, must be unique
- - `age` (integer, optional): User's age in years, 18-120
- **Returns**: User object with id, name, email, created_at
- **Errors**: 400 (validation), 409 (duplicate email), 500 (server error)
- **Example**:
- POST /api/users
- {"name": "Jane Doe", "email": "jane@example.com", "age": 30}
Verwendung von "Reference Builder". Document a database User schema with fields: id, username, email, created_at, status
Erwartetes Ergebnis:
- ### User Schema
- | Field | Type | Constraints | Description |
- |-------|------|-------------|-------------|
- | id | UUID | PRIMARY KEY | Unique identifier |
- | username | VARCHAR(50) | NOT NULL, UNIQUE | User's display name |
- | email | VARCHAR(255) | NOT NULL, UNIQUE | Contact email address |
- | created_at | TIMESTAMP | NOT NULL, DEFAULT NOW() | Account creation time |
- | status | ENUM | NOT NULL, DEFAULT 'active' | Account status: active, suspended, deleted |
- **Indexes**: username_idx, email_idx, status_idx
- **Relationships**: One-to-many with Posts, One-to-one with Profile
Sicherheitsaudit
SicherThis is a prompt-only skill containing no executable code. Static analysis scanned 0 files with 0 lines of code and detected no security patterns. The skill consists entirely of documentation instructions and prompt templates for creating technical references.
Qualitätsbewertung
Was du bauen kannst
API-Referenzgenerierung
Erstellen Sie umfassende API-Dokumentation für interne oder öffentliche APIs mit vollständigen Parameterlisten, Rückgabetypen, Fehlercodes und Verwendungsbeispielen.
Konfigurationsdokumentation
Generieren Sie detaillierte Konfigurationsanleitungen für komplexe Anwendungen, die alle Einstellungen, Standardwerte, Einschränkungen und umgebungsspezifische Werte dokumentieren.
SDK-Dokumentation
Erstellen Sie umfassende SDK-Referenzmaterialien einschließlich Klassenhierarchien, Methodensignaturen, Typdefinitionen und Integrationsbeispiele.
Probiere diese Prompts
Dokumentieren Sie den folgenden API-Endpunkt als vollständigen Referenzeintrag. Schließen Sie die Methodensignatur, alle Parameter mit Typen und Einschränkungen, Rückgabewerte, mögliche Fehler und ein grundlegendes Verwendungsbeispiel ein: Endpoint: [METHOD] [URL] Parameters: [list parameters] Context: [describe what it does]
Erstellen Sie eine umfassende Konfigurationsreferenztabelle für die folgenden Einstellungen. Dokumentieren Sie für jeden Parameter den Typ, Standardwert, gültigen Bereich, ob er erforderlich ist, Umgebungsvariablenname und eventuelle Abhängigkeiten von anderen Einstellungen: [Provide list of configuration parameters]
Generieren Sie vollständige Schemadokumentation für das folgende Datenmodell. Schließen Sie Feldtypen, Validierungsregeln, Einschränkungen, Beziehungen zu anderen Modellen, Indexierungsinformationen ein und geben Sie drei Beispiele: einen minimal gültigen Datensatz, einen vollständig ausgefüllten Datensatz und einen Grenzfall: [Provide schema definition]
Erstellen Sie eine vollständige technische Referenz für das folgende Modul. Strukturieren Sie es mit: 1) Übersichtsabschnitt mit Erklärung des Zwecks, 2) Kurzreferenztabelle aller öffentlichen Methoden, 3) Detaillierte Einträge für jede Methode mit Signaturen, Parametern, Rückgabetypen, Fehlern und Beispielen, 4) Querverweise zwischen verwandten Methoden, 5) Leistungsüberlegungen und 6) Häufige Fallstricke, die vermieden werden sollten: [Provide module source code or interface definition]
Bewährte Verfahren
- Dokumentieren Sie Verhalten und Absicht, nicht Implementierungsdetails - konzentrieren Sie sich darauf, was der Code tut, nicht wie
- Fügen Sie sowohl Happy-Path-Beispiele als auch Fehlerbehandlungsszenarien für vollständige Abdeckung hinzu
- Verwenden Sie durchgängig einheitliche Terminologie - erstellen und befolgen Sie ein Glossar
Vermeiden
- Beispiele schreiben, die die Fehlerbehandlung auslassen - zeigen Sie immer, wie Fehler behandelt werden
- Implementierungsspezifisches Fachjargon anstelle von klarer, benutzerorientierter Sprache verwenden
- Dokumentation ohne Versionsangaben erstellen - geben Sie immer an, für welche Version jede Funktion gilt