Fähigkeiten when-documenting-code-use-doc-generator

📦

when-documenting-code-use-doc-generator

Name: when-documenting-code-use-doc-generator
Author: DNYoussef

v1.0.0 Inhaltsrevision r1 Hohes Risiko ⚙️ Externe Befehle🌐 Netzwerkzugriff📁 Dateisystemzugriff🔑 Umgebungsvariablen

Vollständige Code-Dokumentation generieren

Codebasen fehlen oft aktuelle API-Referenzen, README-Dateien, Kommentare und Diagramme. Diese Skill analysiert die Projektstruktur und erstellt Dokumentationsartefakte für Claude-, Codex- und Claude Code-Workflows.

Unterstützt: Claude Codex Code(CC)

⚠️ 38 Schlecht

Maintain this Skill? Claim it ⚠️ 38 Schlecht

Vor der Installation anhalten und eine Bestätigung anfordern.

Prüfen Sie den Plan und holen Sie vor Änderungen an Dateien die ausdrückliche Zustimmung des Benutzers ein.

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 "when-documenting-code-use-doc-generator" from https://skillstore.io/skills/dnyoussef-when-documenting-code-use-doc-generator.md and its manifest at https://skillstore.io/api/skills/dnyoussef-when-documenting-code-use-doc-generator/manifest. Verify the artifact. Stop and obtain explicit user consent before installing or changing files.

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/dnyoussef-when-documenting-code-use-doc-generator.md Signiertes manifest GET /api/skills/dnyoussef-when-documenting-code-use-doc-generator/manifest Signiertes lockfile GET /api/skills/dnyoussef-when-documenting-code-use-doc-generator/lockfile

Testen

„when-documenting-code-use-doc-generator“ wird verwendet. Ein Node.js-API-Projekt hat Routen, aber keine API-Referenz.

Erwartetes Ergebnis:

Die Skill erstellt eine API-Übersicht mit Endpoint-Zusammenfassungen, Authentifizierungshinweisen, Antwortbeschreibungen und Links zu generierten Dokumentationsdateien.

„when-documenting-code-use-doc-generator“ wird verwendet. Ein Repository hat ein veraltetes README und fehlende Einrichtungsanweisungen.

Erwartetes Ergebnis:

Die Skill entwirft ein aktualisiertes README mit Projektübersicht, Voraussetzungen, Installation, Nutzung, Tests, Konfiguration und Beitragsabschnitten.

„when-documenting-code-use-doc-generator“ wird verwendet. Ein Quellordner enthält öffentliche Funktionen ohne Kommentare.

Erwartetes Ergebnis:

Die Skill meldet die Dokumentationsabdeckung und schlägt Inline-Kommentare für Funktionen vor, die Parameter- und Rückgabebeschreibungen benötigen.

Sicherheitsaudit

Hohes Risiko

v9 • 5.7.2026 Versionsbericht öffnen

Most static findings are false positives from Markdown examples, generated documentation placeholders, or sample configuration names. The executable slash-command scripts are real shell entry points, and the larger concern is their unpinned npx execution of claude-flow plus default writes to repository documentation files.

Gescannte Dateien

3,881

Analysierte Zeilen

Prüfelemente

Falschmeldungen ignoriert

Bestätigte Sicherheitsbedenken (2)

Hoch

slash-command-doc-api.sh:100-103 slash-command-doc-inline.sh:98-102 slash-command-doc-readme.sh:87-91

Unpinned Third-Party Package Execution

The slash-command scripts invoke npx claude-flow@alpha for hooks and memory storage. Running an alpha npm package during documentation generation can download and execute third-party code.

The scripts directly call npx with an external package name in executable paths. This is a clear supply-chain execution risk even though it appears intended for workflow coordination.

Mittel

slash-command-doc-readme.sh:93-99 slash-command-doc-readme.sh:167-178 slash-command-doc-api.sh:94-96 slash-command-doc-api.sh:231-233

Documentation Scripts Modify Repository Files by Default

The README and API scripts create or overwrite documentation files in the current project. This can change repository contents without a dry-run default or confirmation prompt.

The cited script paths create directories, copy generated specs, back up README.md, and write README content. These are intended actions but still affect repository state by default.

Elemente der Fähigkeitsprüfung (3)

Dies sind echte lokale Fähigkeiten, die für diese Fähigkeit erwartet werden können; daher müssen sie überprüft werden, werden jedoch nicht als bestätigtes bösartiges Verhalten gezählt.

Mittel

slash-command-doc-api.sh:1

Unix shell invocation

#!/bin/bash

This is an executable Bash entry point that scans project files and writes documentation outputs. Shell automation is expected, but it is still real command-execution behavior for a marketplace skill.

Mittel

slash-command-doc-inline.sh:1

Unix shell invocation

#!/bin/bash

Mittel

slash-command-doc-readme.sh:1

Unix shell invocation

#!/bin/bash

Risikofaktoren

⚙️ Externe Befehle (180)

🌐 Netzwerkzugriff (34)

📁 Dateisystemzugriff (45)

🔑 Umgebungsvariablen (5)

PROCESS.md:734 SKILL.md:491 SKILL.md:408 SKILL.md:409 slash-command-doc-readme.sh:465

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/dnyoussef-when-documenting-code-use-doc-generator/audits/9?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report

Markdown-Badge

[![Skillstore security assessment](https://skillstore.io/badges/skills/dnyoussef-when-documenting-code-use-doc-generator/security.svg)](https://skillstore.io/skills/dnyoussef-when-documenting-code-use-doc-generator?utm_source=security_passport_badge)

HTML-Badge

<a href="https://skillstore.io/skills/dnyoussef-when-documenting-code-use-doc-generator?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/dnyoussef-when-documenting-code-use-doc-generator/security.svg" alt="Skillstore security assessment" loading="lazy"></a>

Einbettungskarte

<iframe src="https://skillstore.io/embed/skills/dnyoussef-when-documenting-code-use-doc-generator.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

DNYoussef. (2026). when-documenting-code-use-doc-generator security audit report (audit version 9) [Author version 1.0.0]. Skillstore. https://skillstore.io/skills/dnyoussef-when-documenting-code-use-doc-generator/audits/9

BibTeX-Zitat

@techreport{dnyoussef-dnyoussef-when-documenting-code-use-doc-generator-2026,
  author = {DNYoussef},
  title = {when-documenting-code-use-doc-generator security audit report (audit version 9)},
  institution = {Skillstore},
  year = {2026},
  number = {9},
  url = {https://skillstore.io/skills/dnyoussef-when-documenting-code-use-doc-generator/audits/9},
  note = {Author version 1.0.0}
}

CITATION.cff

cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "when-documenting-code-use-doc-generator security audit report (audit version 9)"
version: "1.0.0"
type: report
authors:
  - name: "DNYoussef"
date-released: "2026-07-05"
url: "https://skillstore.io/skills/dnyoussef-when-documenting-code-use-doc-generator/audits/9"
identifiers:
  - type: other
    value: "skillstore:dnyoussef-when-documenting-code-use-doc-generator:audit:9"
    description: "Skillstore immutable audit report identifier"

Skillstore-Score

Warum dieser Score Evidenzvertrauen: Mittel

Architektur

100

Wartbarkeit

Inhalt

Gemeinschaft

Spezifikationskonformität

Was Sie erstellen können

Eine Backend-API dokumentieren

Generiere Referenzen im OpenAPI-Stil, Endpoint-Zusammenfassungen, Authentifizierungshinweise und Nutzungsbeispiele für ein Service-Repository.

Projekt-Onboarding-Dokumentation aktualisieren

Erstelle aus Repository-Metadaten ein README mit Abschnitten zu Einrichtung, Konfiguration, Tests, Beiträgen und Support.

Code-Kommentarabdeckung verbessern

Identifiziere undokumentierte Funktionen und erstelle Leitlinien für Inline-Kommentare für unterstützte Sprachstile.

Diese Prompts ausprobieren

Basisdokumentation generieren

Verwende diese Skill, um das aktuelle Repository zu prüfen und grundlegende README- und API-Dokumentation zu generieren. Halte die Ausgabe knapp und liste geänderte Dateien auf.

API-Referenz erstellen

Verwende diese Skill, um die REST API in diesem Projekt zu dokumentieren. Beziehe Endpoints, Anfrageformate, Antwortzusammenfassungen, Authentifizierungshinweise und Validierungswarnungen ein.

Inline-Kommentare hinzufügen

Verwende diese Skill, um undokumentierte öffentliche Funktionen in src zu finden. Füge JSDoc, TSDoc oder Python docstrings hinzu oder schlage sie vor, und vermeide Änderungen an der Geschäftslogik.

Vollständiges Dokumentationsset erstellen

Verwende diese Skill, um README, API-Referenz, Architekturhinweise, Empfehlungen für Inline-Kommentare und einen Bericht zu Dokumentationslücken zu generieren. Führe sie nach Möglichkeit im dry-run mode aus und kennzeichne riskante Schreibvorgänge vor dem Bearbeiten.

Bewährte Praktiken

Führe die Skill in einem sauberen Branch aus und überprüfe generierte Dateien vor dem Mergen.
Gib den Zieltyp der Dokumentation, das bevorzugte Format und das Abdeckungsziel an.
Halte Geheimnisse aus Beispielen heraus und ersetze Platzhalter vor der Veröffentlichung.

Vermeiden

Führe Generierungsskripte nicht gegen Repositories mit uncommitted kritischen Änderungen aus.
Veröffentliche generierte API-Details nicht, bevor Authentifizierung und Datenoffenlegung geprüft wurden.
Gehe nicht davon aus, dass Beispiele ohne Validierung produktionsreif sind.