Compétences code-documentation-doc-generate
📦

code-documentation-doc-generate

Sûr

Code-Dokumentation automatisch generieren

Erstellen Sie umfassende API-Dokumentation, Architekturdiagramme, Benutzerhandbücher und technische Referenzen aus Quellcode mittels KI-gestützter Analyse.

Prend en charge: Claude Codex Code(CC)
🥉 72 Bronze
1

Télécharger le ZIP du skill

2

Importer dans Claude

Allez dans Paramètres → Capacités → Skills → Importer un skill

3

Activez et commencez à utiliser

Tester

Utilisation de "code-documentation-doc-generate". Generate API documentation for a FastAPI user service with endpoints for create, read, update, delete users

Résultat attendu:

  • API-Dokumentation erstellt mit:
  • - OpenAPI 3.0-Spezifikation
  • - Benutzer-Endpunkte (/users, /users/{id})
  • - Anfrage-/Antwort-Schemata mit Validierung
  • - Authentifizierungs- und Autorisierungsabschnitte
  • - Beispiel-curl-Befehle für jeden Endpunkt

Utilisation de "code-documentation-doc-generate". Create a README for a Python CLI tool that converts images to PDF

Résultat attendu:

  • README generiert mit:
  • - Projekttitel und Beschreibung
  • - Installationsanleitung (pip, conda)
  • - Schnellstartanleitung mit Beispielen
  • - Konfigurationsoptionen-Tabelle
  • - Lizenz- und Beitragsrichtlinien

Audit de sécurité

Sûr
v1 • 2/25/2026

All 91 static findings are false positives triggered by documentation examples in the skill. The skill provides templates and examples for generating documentation. No actual code execution, network calls, or credential access occurs. Risk level: SAFE.

2
Fichiers analysés
692
Lignes analysées
1
résultats
1
Total des audits
Problèmes à risque faible (1)
resources/implementation-playbook.md:1-641SKILL.md:1-51
Static Scanner Pattern Detection in Documentation Examples
The static scanner detected 91 potential security patterns in documentation examples. These findings are false positives triggered by template variables (${VARIABLE}), code block fences (```), and example URLs in the implementation playbook. No actual code execution, network calls, or credential access occurs.
Audité par: claude

Score de qualité

38
Architecture
100
Maintenabilité
87
Contenu
27
Communauté
100
Sécurité
100
Conformité aux spécifications

Ce que vous pouvez construire

API-Dokumentation für Webdienste

Automatische Generierung von OpenAPI-Spezifikationen und interaktiver API-Dokumentation aus REST-Endpunktcode

Projekt-README-Generierung

Erstellen Sie umfassende README-Dateien mit Installationsanleitung, Nutzungsbeispielen und Beitragsrichtlinien

Architekturdokumentation

Generieren Sie Systemarchitekturdiagramme und Komponentendokumentation aus der Codestruktur

Essayez ces prompts

Basis-API-Dokumentation 
Generieren Sie API-Dokumentation für die Endpunkte in diesem Codebase. Beziehen Sie Anfrage-/Antwort-Schemata, Authentifizierungsanforderungen und Beispielanfragen mit ein.
Vollständiges Projekt-README 
Erstellen Sie eine umfassende README.md für dieses Projekt. Beziehen Sie ein: Projektbeschreibung, Installationsschritte, Nutzungsbeispiele, Konfigurationsoptionen und Beitragsrichtlinien.
Architekturübersicht 
Analysieren Sie die Codebase-Struktur und generieren Sie Architekturdokumentation. Beziehen Sie ein: Systembeschreibung, Komponentenbeschreibungen, Datenflüsse und Technologie-Stack-Zusammenfassung.
Dokumentationsautomatisierung einrichten 
Richten Sie automatisierte Dokumentationsgenerierung für dieses Projekt ein. Beziehen Sie CI/CD-Konfiguration, Dokumentations-Linting-Regeln und Bereitstellung auf einer Dokumentations-Hosting-Plattform mit ein.

Bonnes pratiques

  • Überprüfen Sie immer, ob generierte Dokumentation durch Tests mit dem tatsächlichen Codeverhalten übereinstimmt
  • Halten Sie die Dokumentation mittels CI/CD-Automatisierung mit dem Code synchron
  • Fügen Sie praktische Codebeispiele bei, die Benutzer kopieren und anpassen können

Éviter

  • Dokumentation generieren, ohne sie auf Richtigkeit zu überprüfen
  • Sensible Informationen wie API-Schlüssel oder interne URLs in öffentliche Dokumente aufnehmen
  • Dokumentation erstellen, die nicht automatisch überprüft oder getestet werden kann

Foire aux questions

Welche Arten von Dokumentation kann dieses Skill generieren?
Dieses Skill kann API-Dokumentation, Architekturdiagramme, README-Dateien, Benutzerhandbücher und technische Referenzen generieren. Es unterstützt OpenAPI/Swagger-Spezifikationen, Mermaid-Diagramme und verschiedene Dokumentationsformate.
Führt dieses Skill Code in meinem Projekt aus?
Nein. Dieses Skill analysiert Ihren Code, um seine Struktur zu verstehen, und generiert Dokumentation basierend auf dieser Analyse. Es modifiziert oder führt Ihren Codebase nicht aus.
Kann ich dies in meine CI/CD-Pipeline integrieren?
Ja. Das Skill enthält Anleitungen für die Einrichtung automatisierter Dokumentationsgenerierung in CI/CD-Pipelines mit Tools wie GitHub Actions, GitLab CI oder ähnlichen Plattformen.
Welche Programmiersprachen werden unterstützt?
Das Skill funktioniert mit jeder Programmiersprache. Es analysiert die Codestruktur und generiert sprachunabhängige Dokumentation. Unterstützung für bestimmte Sprachen hängt vom Dokumentationsformat ab (z.B. JSDoc für JavaScript, Docstrings für Python).
Wie halte ich die Dokumentation mit meinem Code synchron?
Richten Sie automatisierte Dokumentationsgenerierung in Ihrer CI-Pipeline ein, um sie bei jedem Commit auszuführen. Sie können auch Dokumentations-Linting-Tools verwenden, um Inkonsistenzen vor der Bereitstellung zu erkennen.
Kann dieses Skill private oder interne APIs dokumentieren?
Ja. Das Skill kann jede API dokumentieren. Stellen Sie jedoch sicher, dass Sie die generierte Dokumentation überprüfen, um sensible interne URLs, Anmeldedaten oder proprietäre Informationen zu entfernen, bevor Sie sie extern teilen.

Détails du développeur

Auteur

sickn33

Licence

MIT

Dépôt

https://github.com/sickn33/antigravity-awesome-skills/tree/main/skills/code-documentation-doc-generate

Réf

main

Structure de fichiers

📁 resources/

📄 implementation-playbook.md

📄 SKILL.md