Fähigkeiten documentation-fundamentals

📦

documentation-fundamentals

Name: documentation-fundamentals
Author: DanielPodolsky

Inhaltsrevision r1 Sicher ⚙️ Externe Befehle

Qualität der Entwicklerdokumentation verbessern

Schwache Dokumentation verlangsamt das Onboarding und erschwert die Wartung von Code. Diese Skill unterstützt Reviews von README, JSDoc und Inline-Kommentaren mit praxisnahen Standards.

Unterstützt: Claude Codex Code(CC)

🥉 78 Bronze

Maintain this Skill? Claim it 🥉 78 Bronze

Mit meinem Agent installieren

Kopieren Sie diese Anfrage in Ihren Agent. Sie enthält die maßgebliche Skill-Seite und das Manifest.

Agent-Anfrage

Review the Skillstore skill "documentation-fundamentals" from https://skillstore.io/skills/danielpodolsky-documentation-fundamentals.md and its manifest at https://skillstore.io/api/skills/danielpodolsky-documentation-fundamentals/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.

Ihr Agent sollte weiterhin seinen Plan anzeigen und alle von der Sicherheitsrichtlinie verlangten Bestätigungen anfordern.

Agent-lesbare Ressourcen

Verwenden Sie diese Links, wenn ein KI-Agent, Crawler oder Skript sauberen Kontext benötigt, statt die vollständige Seite zu lesen.

Markdown-Detailseite GET /skills/danielpodolsky-documentation-fundamentals.md Signiertes manifest GET /api/skills/danielpodolsky-documentation-fundamentals/manifest Signiertes lockfile GET /api/skills/danielpodolsky-documentation-fundamentals/lockfile

Testen

„documentation-fundamentals“ wird verwendet. Ein README enthält nur einen Projektnamen und einen standardmäßigen Gerüstsatz.

Erwartetes Ergebnis:

Füge eine Zweckbeschreibung in einem Satz hinzu.
Erkläre das Problem, das das Projekt löst.
Füge Installations- und Schnellstartschritte hinzu, denen ein neuer Entwickler folgen kann.

„documentation-fundamentals“ wird verwendet. Inline-Kommentare wiederholen Zuweisungen, Schleifen und offensichtliche Property-Zugriffe.

Erwartetes Ergebnis:

Entferne Kommentare, die sichtbares Verhalten wiederholen.
Behalte Kommentare nur dort, wo sie Absicht, Einschränkungen oder ungewöhnliche Entscheidungen erklären.

„documentation-fundamentals“ wird verwendet. Ein exportiertes Utility hat Parameternamen, aber keine Nutzungshinweise.

Erwartetes Ergebnis:

Füge Beschreibungen für Parameter und Rückgabewerte hinzu.
Füge ein Beispielergebnis in Prosa hinzu.
Dokumentiere Fehler oder Einschränkungen, die Aufrufer behandeln müssen.

Sicherheitsaudit

Sicher

v8 • 6.7.2026 Versionsbericht öffnen

All static findings are false positives caused by Markdown fences, inline code formatting, or prose examples in SKILL.md. I found no executable scripts, prompt injection, data exfiltration intent, or system reconnaissance behavior in the reviewed skill.

Gescannte Dateien

335

Analysierte Zeilen

Prüfelemente

Falschmeldungen ignoriert

Das letzte abgeschlossene statische und semantische Audit erkannte keine bestätigten Sicherheitsbefunde. Dies beweist nicht, dass der Skill keine Nebenwirkungen hat.

Geprüft von: codex Audit-Verlauf anzeigen →

Diesen Bericht teilen & zitieren

Teile den versionierten Bewertungsbericht, das neutrale Badge, die Einbettungskarte und Zitate. Skillstore berichtet Nachweise, ohne zu entscheiden, ob dieser Skill sicher ist.

Versionsbericht öffnen

Berichtslink kopieren

https://skillstore.io/skills/danielpodolsky-documentation-fundamentals/audits/8?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report

Markdown-Badge

[![Skillstore security assessment](https://skillstore.io/badges/skills/danielpodolsky-documentation-fundamentals/security.svg)](https://skillstore.io/skills/danielpodolsky-documentation-fundamentals?utm_source=security_passport_badge)

HTML-Badge

<a href="https://skillstore.io/skills/danielpodolsky-documentation-fundamentals?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/danielpodolsky-documentation-fundamentals/security.svg" alt="Skillstore security assessment" loading="lazy"></a>

Einbettungskarte

<iframe src="https://skillstore.io/embed/skills/danielpodolsky-documentation-fundamentals.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>

Wissenschaftliche Zitate (APA · BibTeX · CFF)

APA-Zitat

DanielPodolsky. (2026). documentation-fundamentals security audit report (audit version 8) [Author version unspecified]. Skillstore. https://skillstore.io/skills/danielpodolsky-documentation-fundamentals/audits/8

BibTeX-Zitat

@techreport{danielpodolsky-danielpodolsky-documentation-fundamentals-2026,
  author = {DanielPodolsky},
  title = {documentation-fundamentals security audit report (audit version 8)},
  institution = {Skillstore},
  year = {2026},
  number = {8},
  url = {https://skillstore.io/skills/danielpodolsky-documentation-fundamentals/audits/8},
  note = {Author version unspecified}
}

CITATION.cff

cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "documentation-fundamentals security audit report (audit version 8)"
version: "unspecified"
type: report
authors:
  - name: "DanielPodolsky"
date-released: "2026-07-06"
url: "https://skillstore.io/skills/danielpodolsky-documentation-fundamentals/audits/8"
identifiers:
  - type: other
    value: "skillstore:danielpodolsky-documentation-fundamentals:audit:8"
    description: "Skillstore immutable audit report identifier"

Skillstore-Score

Warum dieser Score Evidenzvertrauen: Hoch

Architektur

Wartbarkeit

Inhalt

Gemeinschaft

Spezifikationskonformität

Was Sie erstellen können

README-Bereitschaft prüfen

Prüfen, ob ein README vor dem Release Zweck, Installation, Schnellstart und Beitragsablauf erklärt.

API-Kommentare verbessern

JSDoc überarbeiten, damit exportierte Funktionen Parameter, Rückgabewerte, Fehler, Beispiele und Absicht erklären.

Code-Reviews coachen

Fokussierte Fragen nutzen, um zu vermitteln, wann Kommentare Kontext hinzufügen und wann Code für sich selbst stehen sollte.

Diese Prompts ausprobieren

Einfacher README-Review

Überprüfe dieses README anhand der fünf wesentlichen Punkte: Zweck, Problem, Installation, Schnellstart und Beitragsleitfaden. Liste fehlende Abschnitte und konkrete Korrekturen auf.

Inline-Kommentare bereinigen

Überprüfe diese Inline-Kommentare. Markiere Kommentare, die nur den Code wiederholen. Behalte Kommentare, die Absicht, Einschränkungen oder geschäftlichen Kontext erklären.

JSDoc-Vollständigkeit prüfen

Bewerte diese API-Dokumentation auf JSDoc-Vollständigkeit. Prüfe Parameter, Rückgabewerte, Fehler, Beispiele, verwandte APIs und Hinweise zur Veraltung.

Dokumentationsplan für das Repository

Erstelle einen Dokumentationsreview-Plan für dieses Repository. Priorisiere README-Lücken, exportierte API-Dokumentation, Inline-Kommentare und Risiken durch veraltete Dokumentation.

Bewährte Praktiken

Dokumentiere, warum Entscheidungen existieren, wenn der Code das Verhalten bereits zeigt.
Halte README-Schritte kopierbereit und von einem neuen Entwickler getestet.
Aktualisiere Kommentare, wenn sich Verhalten ändert, oder entferne Kommentare, die keinen Kontext mehr hinzufügen.

Vermeiden

Kommentare hinzufügen, die Variablennamen, Schleifen oder Zuweisungen wiederholen.
Auskommentierten Code stehen lassen, statt sich auf die Versionshistorie zu verlassen.
README-Gerüsttext veröffentlichen, der keinen echten Zweck oder keine echte Einrichtung erklärt.

Häufig gestellte Fragen

Kann diese Skill ein vollständiges README schreiben?

Ja. Sie kann ein README entwerfen, wenn du Projektzweck, Installationsschritte, Nutzungsbeispiele und Beitragsregeln bereitstellst.

Führt sie Dokumentationstests aus?

Nein. Sie gibt Review-Leitlinien, führt aber keine Befehle aus und überprüft keine Beispiele.

Welche Tools können sie verwenden?

Sie ist mit Skill-Workflows von Claude, Codex und Claude Code kompatibel.

Kann sie Kommentare in jeder Sprache prüfen?

Ja. Die Prinzipien gelten allgemein, aber sprachspezifische Tags sollten dem Projektstandard folgen.

Ersetzt sie einen technischen Review?

Nein. Sie verbessert Klarheit und Wartbarkeit, beweist aber weder API-Verhalten noch Sicherheitskorrektheit.

Wie sollte ich Kontext bereitstellen?

Teile das README, die Kommentare, die Zielgruppe und alle bekannten Setup-Regeln, bevor du um einen Review bittest.

Entwicklerdetails

Autor

DanielPodolsky

Lizenz

MIT

Skillstore-Revision

Versionshinweis

Der Autor hat keine Version angegeben.

Repository

https://github.com/DanielPodolsky/mentor-spec/tree/main/.claude/skills/fundamentals/documentation

Ref.

34f316ba14ef36c7a620fc09f2676d2429997a77

Aktualität der Wartung

22.7.2026

Nutzung

5 Downloads · 220 Aufrufe

Dateistruktur

📄 SKILL.md

documentation-fundamentals

Mit meinem Agent installieren

Agent-lesbare Ressourcen

Testen

Sicherheitsaudit

Risikofaktoren

Berichtslink kopieren

Markdown-Badge

HTML-Badge

Einbettungskarte

APA-Zitat

BibTeX-Zitat

CITATION.cff

Skillstore-Score

Was Sie erstellen können

README-Bereitschaft prüfen

API-Kommentare verbessern

Code-Reviews coachen

Diese Prompts ausprobieren

Bewährte Praktiken

Vermeiden

Häufig gestellte Fragen

Entwicklerdetails