documentation
Technische Dokumentation erstellen
Auch verfügbar von: DaoThiHuong2111,Joseph OBrien,Joseph OBrien,CrazySwami,BfdCampos
Dieses Skill automatisiert die Erstellung technischer Dokumentation, einschließlich API-Dokumentation, README-Dateien und Architekturdokumenten. Es hilft Entwicklern, konsistente, professionelle Dokumentation ohne manuellen Aufwand zu pflegen.
Die Skill-ZIP herunterladen
In Claude hochladen
Gehe zu Einstellungen → Fähigkeiten → Skills → Skill hochladen
Einschalten und loslegen
Teste es
Verwendung von "documentation". Generate a README for a Python CLI tool that processes CSV files
Erwartetes Ergebnis:
# CSV Processor CLI
A command-line tool for processing and transforming CSV files.
## Installation
```bash
pip install csv-processor
```
## Usage
```bash
csv-processor input.csv --output output.csv --transform uppercase
```
## Features
- Read and write CSV files
- Apply transformations
- Filter rows by condition
- Export to multiple formats
Verwendung von "documentation". Document this API endpoint: POST /users/{id}/orders
Erwartetes Ergebnis:
## Create User Order
**Endpoint:** `POST /users/{id}/orders`
Creates a new order for a specific user.
### Parameters
- `id` (path, required): User's unique identifier
- `items` (body, required): Array of order items
- `shipping_address` (body, required): Delivery address
### Response
```json
{
"order_id": "ord_123",
"status": "pending",
"total": 99.99
}
```
Sicherheitsaudit
Hohes RisikoStatic analysis detected 72 potential security issues including 61 instances of shell command execution, 11 references to weak cryptographic algorithms, and 2 instances of system reconnaissance patterns. These patterns are highly unusual for a documentation skill and require manual review. The high density of external command invocations and security-related patterns suggests this skill may contain functionality beyond simple documentation generation.
Probleme mit hohem Risiko (1)
Probleme mit mittlerem Risiko (1)
Probleme mit niedrigem Risiko (1)
Risikofaktoren
⚙️ Externe Befehle (61)
⚡ Enthält Skripte
Erkannte Muster
Qualitätsbewertung
Was du bauen kannst
API-Dokumentationsgenerierung
Automatische Erstellung umfassender API-Dokumentation aus Quellcode, einschließlich Endpunkten, Parametern und Antworttypen.
Projekt-README-Erstellung
Erstellung polierter README-Dateien mit Erste-Schritte-Anleitungen, Installationsanweisungen und Beitrittsrichtlinien.
Code-Kommentar-Verbesserung
Hinzufügen oder Verbessern von Inline-Code-Kommentaren und Docstrings zur Verbesserung der Code-Lesbarkeit und Wartbarkeit.
Probiere diese Prompts
Generate a README.md file for this project. Include sections for: Project title, Description, Installation, Usage, Contributing, and License.
Generate API documentation for the following code. Include endpoint descriptions, parameter details, request/response examples, and error codes.
Create architecture documentation including system overview, component diagram descriptions, data flow, and design decisions for this codebase.
Add comprehensive inline comments and docstrings to the following code. Explain complex logic, document parameters and return values, and add header comments to files.
Bewährte Verfahren
- Geben Sie klare, spezifische Anweisungen zum gewünschten Dokumentationsformat und zur Struktur
- Fügen Sie vorhandene Dokumentation oder Code-Kontext hinzu, wenn Sie nach Updates fragen
- Überprüfen Sie die generierte Dokumentation auf technische Genauigkeit, bevor Sie sie veröffentlichen
- Verwenden Sie konsistente Formatierungs- und Stilrichtlinien in der gesamten Dokumentation
Vermeiden
- Anfordern von Dokumentation ohne Bereitstellung von Quellcode oder Kontext
- Erwarten, dass das Skill Laufzeitverhalten ohne Ausführung versteht
- Sich ausschließlich auf generierte Dokumente ohne manuelle technische Überprüfung verlassen
- Dokumentation für Code ohne Kommentare oder Struktur generieren