Fähigkeiten documentation-templates
📦

documentation-templates

Sicher

Professionelle Dokumentation schnell erstellen

Dieses Skill bietet sofort einsetzbare Vorlagen für README-Dateien, API-Dokumentation, Codekommentare, Changelogs und KI-freundliche Dokumentationsformate.

Unterstützt: Claude Codex Code(CC)
📊 70 Angemessen
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-templates". Verwende documentation-templates, um eine README für eine Node.js API zu erstellen

Erwartetes Ergebnis:

Eine vollständige README.md mit Abschnitten: Titel + Einzeiler, Quick Start, Features, Konfigurationstabelle, API-Referenz-Link, Contributing-Richtlinien, Lizenz

Verwendung von "documentation-templates". Verwende documentation-templates, um einen GET /users Endpunkt zu dokumentieren

Erwartetes Ergebnis:

API-Dokumentation mit Endpunktbeschreibung, Parametertabelle (id: string, erforderlich), Antwortcodes (200, 404) und Beispielanfrage/-antwort

Verwendung von "documentation-templates". Verwende documentation-templates, um ein ADR für Datenbankauswahl zu erstellen

Erwartetes Ergebnis:

ADR-Dokument mit Status (Accepted/Deprecated/Superseded), Context (warum die Entscheidung notwendig ist), Decision (was entschieden wurde), Consequences (Kompromisse)

Sicherheitsaudit

Sicher
v1 • 2/24/2026

All 23 static findings are false positives. The skill contains only markdown documentation templates with no executable code. The detected patterns (external_commands, weak cryptographic algorithms, system reconnaissance) are markdown code fences, plain English text, and API documentation placeholders - not actual security risks.

1
Gescannte Dateien
200
Analysierte Zeilen
0
befunde
1
Gesamtzahl Audits
Keine Sicherheitsprobleme gefunden

Erkannte Muster

External Command Execution (False Positive)Weak Cryptographic Algorithm (False Positive)System Reconnaissance (False Positive)
Auditiert von: claude

Qualitätsbewertung

38
Architektur
100
Wartbarkeit
87
Inhalt
26
Community
100
Sicherheit
91
Spezifikationskonformität

Was du bauen kannst

Neueinrichtung eines Projekts

Schnell Dokumentation für ein neues Projekt mit README-, API-Dokumentations- und Changelog-Vorlagen erstellen.

Dokumentationsstandards

Konsistenten Dokumentationsstil über Teamprojekte hinweg mit standardisierten Vorlagen beibehalten.

KI-Agent-Integration

Dokumentation erstellen, die KI-Agenten wie Claude und Codex verstehen und effektiv nutzen können.

Probiere diese Prompts

Basis-README erstellen 
Verwende das documentation-templates Skill, um eine README.md für mein [project type] Projekt zu erstellen. Füge Abschnitte für Quick Start, Features und Konfiguration hinzu.
API-Endpunkte dokumentieren 
Verwende das documentation-templates Skill, um API-Dokumentation für meine REST-API mit Endpunkten für [list endpoints] zu erstellen.
Codekommentare schreiben 
Verwende das documentation-templates Skill, um JSDoc-Kommentare zu meiner Funktion hinzuzufügen, die [describe function purpose].
Architecture Decision Record erstellen 
Verwende das documentation-templates Skill, um ein ADR für [decision title] zu erstellen. Füge Abschnitte für Context, Decision und Consequences hinzu.

Bewährte Verfahren

  • Beginne zuerst mit wichtigen Abschnitten (Titel, Quick Start, Features) bevor du detaillierte Dokumentation hinzufügst
  • Verwende Vorlagen als Ausgangspunkte und passe die Struktur an deine Projektanforderungen an
  • Halte die Dokumentation aktuell - veraltete Dokumente sind schlimmer als keine Dokumentation
  • Füge Beispiele in deiner Dokumentation hinzu, um Benutzern schnelles Verständnis zu ermöglichen

Vermeiden

  • Kopiere Vorlagen nicht wortwörtlich ohne Anpassung an deinen Projektkontext
  • Vermeide die Dokumentation von Implementierungsdetails in benutzerorientierten README-Dateien
  • Überspringe nicht den Quick Start-Abschnitt - Benutzer wollen schnell loslegen
  • Vermeide veraltete Dokumentationsformate, die KI-Agenten nicht analysieren können

Häufig gestellte Fragen

Mit welchen Tools ist dieses Skill kompatibel?
Dieses Skill funktioniert mit Claude, Codex und Claude Code. Verwende es mit den Read, Glob und Grep Tools.
Muss ich die Vorlagen anpassen?
Ja, Vorlagen sind Ausgangspunkte. Passe die Platzhalter und Struktur an die spezifischen Anforderungen deines Projekts an.
Kann ich dies für kommerzielle Projekte verwenden?
Ja, das Skill ist unter MIT lizenziert, was kommerzielle Nutzung mit Namensnennung erlaubt.
Was ist llms.txt?
llms.txt ist ein Dokumentationsformat, das für KI-Crawler und -Agenten entwickelt wurde. Es bietet eine strukturierte Übersicht, die KI-Modelle einfach analysieren und verstehen können.
Wie unterscheidet sich dies von automatisch generierten Dokumenten?
Dieses Skill bietet von Menschen geschriebene Vorlagen, die Klarheit und Scannbarkeit priorisieren. Automatisch generierte Dokumente haben oft keine richtige Struktur und keinen Kontext.
Kann dieses Skill tatsächlichen Code generieren?
Nein, dieses Skill generiert nur Dokumentationsstrukturen und Vorlagen. Es erzeugt keinen ausführbaren Code.

Entwicklerdetails

Autor

sickn33

Lizenz

MIT

Repository

https://github.com/sickn33/antigravity-awesome-skills/tree/main/skills/documentation-templates

Ref

main

Dateistruktur

📄 SKILL.md