Fähigkeiten documentation
📦

documentation

Hohes Risiko ⚙️ Externe Befehle⚡ Enthält Skripte

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.

Unterstützt: Claude Codex Code(CC)
⚠️ 57 Schlecht
1

Die Skill-ZIP herunterladen

2

In Claude hochladen

Gehe zu Einstellungen → Fähigkeiten → Skills → Skill hochladen

3

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 Risiko
v1 • 2/24/2026

Static 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.

1
Gescannte Dateien
262
Analysierte Zeilen
5
befunde
1
Gesamtzahl Audits

Probleme mit hohem Risiko (1)

Weak Cryptographic Algorithm References
The skill contains 11 references to weak cryptographic algorithms. This is unusual for a documentation skill and may indicate the skill implements cryptographic functionality rather than just documenting it. Possible legitimate use: educational content about crypto vulnerabilities. Possible malicious: actual weak crypto implementation.
Probleme mit mittlerem Risiko (1)
Ruby/Shell Backtick Command Execution
The skill contains 61 instances of Ruby/shell backtick execution. While a documentation tool might legitimately invoke documentation generators via shell, the volume is unusual and warrants verification that commands are hardcoded and safe.
Probleme mit niedrigem Risiko (1)
System Reconnaissance Patterns
The skill contains 2 references to system reconnaissance patterns. This is highly unusual for a documentation skill and may indicate the skill performs system enumeration rather than just documenting code.

Erkannte Muster

Shell Command Execution via BackticksCryptographic Weakness References
Auditiert von: claude

Qualitätsbewertung

38
Architektur
100
Wartbarkeit
87
Inhalt
50
Community
13
Sicherheit
83
Spezifikationskonformität

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

Basis-README-Generierung
Generate a README.md file for this project. Include sections for: Project title, Description, Installation, Usage, Contributing, and License.
API-Dokumentation
Generate API documentation for the following code. Include endpoint descriptions, parameter details, request/response examples, and error codes.
Architekturdokumentation
Create architecture documentation including system overview, component diagram descriptions, data flow, and design decisions for this codebase.
Code-Kommentierung
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

Häufig gestellte Fragen

Kann dieses Skill Dokumentation für jede Programmiersprache generieren?
Ja, es unterstützt die meisten gängigen Sprachen, einschließlich Python, JavaScript, Java, Go und Ruby. Die Qualität hängt von der Codestruktur und vorhandenen Kommentaren ab.
Benötigt es Zugriff auf eine laufende Anwendung?
Nein, es generiert Dokumentation aus statischem Quellcode. Sie benötigen keine laufende Anwendung.
Kann es vorhandene Dokumentation aktualisieren?
Ja, Sie können vorhandene Dokumentation bereitstellen und das Skill bitten, diese zu aktualisieren, zu erweitern oder mit Codeänderungen zu synchronisieren.
Welche Formate kann es ausgeben?
Primäre Ausgabe ist Markdown, aber es kann auch HTML, Klartext und Formate für bestimmte Dokumentationssysteme generieren.
Wie genau ist die generierte API-Dokumentation?
Die Genauigkeit hängt von der Codequalität ab. Gut strukturierter Code mit klaren Funktionssignaturen und Kommentaren erzeugt genaue Dokumentation. Komplexe Logik kann eine manuelle Überprüfung erfordern.
Kann es Microservices-Architekturen dokumentieren?
Ja, es kann Service-Interaktionen, API-Verträge und Systemarchitektur dokumentieren, wenn die relevanten Code- und Konfigurationsdateien bereitgestellt werden.

Entwicklerdetails

Dateistruktur

📄 SKILL.md