スキル when-documenting-code-use-doc-generator

📦

when-documenting-code-use-doc-generator

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

v1.0.0 コンテンツリビジョン r1 高リスク ⚙️ 外部コマンド🌐 ネットワークアクセス📁 ファイルシステムへのアクセス🔑 環境変数

完全なコードドキュメントを生成

コードベースでは、最新の API リファレンス、README ファイル、コメント、図が不足していることがよくあります。このスキルはプロジェクト構造を分析し、Claude、Codex、Claude Code のワークフロー向けにドキュメント成果物を生成します。

対応: Claude Codex Code(CC)

⚠️ 38 不十分

インストール前に停止して確認を求めてください。

計画を確認し、ファイルを変更する前にユーザーの明示的な同意を得てください。

自分のエージェントでインストール

このリクエストをエージェントにコピーしてください。正規の Skill ページとマニフェストが含まれています。

エージェントリクエスト

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.

エージェントは引き続き計画を提示し、セキュリティポリシーで必要な確認を求める必要があります。

エージェントが読めるリソース

AI エージェント、クローラー、スクリプトがページ全体ではなく整理されたコンテキストを必要とする場合は、これらのリンクを使ってください。

Markdown詳細 GET /skills/dnyoussef-when-documenting-code-use-doc-generator.md 署名済み manifest GET /api/skills/dnyoussef-when-documenting-code-use-doc-generator/manifest 署名済み lockfile GET /api/skills/dnyoussef-when-documenting-code-use-doc-generator/lockfile

テストする

「when-documenting-code-use-doc-generator」を使用しています。 Node.js API プロジェクトにルートはあるが、API リファレンスがない。

期待される結果:

このスキルは、エンドポイント概要、認証メモ、レスポンス説明、生成されたドキュメントファイルへのリンクを含む API 概要を作成します。

「when-documenting-code-use-doc-generator」を使用しています。リポジトリの README が古く、セットアップ手順が不足している。

期待される結果:

このスキルは、プロジェクト概要、前提条件、インストール、使用方法、テスト、設定、コントリビューションのセクションを含む更新版 README の下書きを作成します。

「when-documenting-code-use-doc-generator」を使用しています。ソースフォルダに、コメントのない公開関数が含まれている。

期待される結果:

このスキルはドキュメントカバレッジをレポートし、パラメーターと戻り値の説明が必要な関数に対してインラインコメントを提案します。

セキュリティ監査

高リスク

v9 • 2026/7/5 バージョン別レポートを開く

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.

スキャンされたファイル

3,881

解析済み行数

レビュー項目

誤検知を無視

確認済みのセキュリティ上の懸念 (2)

高

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.

中

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.

機能レビュー項目 (3)

これらは、このスキルに期待される可能性のある実際のローカル機能であるため、レビューが必要ですが、確認済みの悪意ある動作としてはカウントされません。

中

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.

中

slash-command-doc-inline.sh:1

Unix shell invocation

#!/bin/bash

中

slash-command-doc-readme.sh:1

Unix shell invocation

#!/bin/bash

リスク要因

⚙️ 外部コマンド (180)

🌐 ネットワークアクセス (34)

📁 ファイルシステムへのアクセス (45)

🔑 環境変数 (5)

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

監査者: codex 監査履歴を表示 →

このレポートを共有・引用

バージョン付き評価レポート、中立的なバッジ、埋め込みカード、引用を共有できます。Skillstore は証拠を報告しますが、この Skill が安全かどうかは判断しません。

バージョン別レポートを開く

レポートリンクをコピー

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バッジ

[![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バッジ

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

埋め込みカード

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

学術引用 (APA · BibTeX · CFF)

APA形式の引用

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形式の引用

@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 スコア

このスコアの理由証拠の信頼度: 中

アーキテクチャ

100

保守性

コンテンツ

コミュニティ

仕様準拠

作成できるもの

Backend API をドキュメント化する

サービスリポジトリ向けに、OpenAPI スタイルのリファレンス、エンドポイント概要、認証メモ、使用例を生成します。

プロジェクトのオンボーディングドキュメントを更新する

リポジトリメタデータから、セットアップ、設定、テスト、コントリビューション、サポートのセクションを含む README を作成します。

コードコメントのカバレッジを改善する

ドキュメント化されていない関数を特定し、対応言語のスタイルに合わせたインラインコメントのガイダンスを作成します。

これらのプロンプトを試す

基本ドキュメントを生成

このスキルを使用して現在のリポジトリをレビューし、基本的な README と API ドキュメントを生成してください。出力は簡潔にし、変更されたファイルを一覧表示してください。

API リファレンスを作成

このスキルを使用して、このプロジェクトの REST API をドキュメント化してください。エンドポイント、リクエスト形式、レスポンス概要、認証メモ、検証に関する警告を含めてください。

インラインコメントを追加

このスキルを使用して、src 内のドキュメント化されていない公開関数を見つけてください。JSDoc、TSDoc、または Python docstrings を追加または提案し、ビジネスロジックは変更しないでください。

完全なドキュメントセットを構築

このスキルを使用して、README、API リファレンス、アーキテクチャメモ、インラインコメントの推奨事項、ドキュメントギャップレポートを生成してください。可能な場合は dry-run モードで実行し、編集前にリスクのある書き込みを明示してください。

ベストプラクティス

クリーンなブランチでスキルを実行し、マージ前に生成されたファイルをレビューします。
対象のドキュメントタイプ、希望する形式、カバレッジ目標を指定します。
例からシークレットを除外し、公開前にプレースホルダーを置き換えます。

回避

コミットされていない重要な変更があるリポジトリに対して生成スクリプトを実行しないでください。
認証とデータ露出を確認する前に、生成された API 詳細を公開しないでください。
検証なしに例が本番環境対応であると想定しないでください。

よくある質問

このスキルはプロジェクトファイルを編集しますか？

はい。含まれているスクリプトは README と docs の出力を作成できるため、コミット前に変更をレビューしてください。

OpenAPI ドキュメントを生成できますか？

はい。このスキルには、OpenAPI スタイルのリファレンスとエンドポイント概要を生成する API ドキュメントワークフローが含まれています。

このスキルではどの言語について説明されていますか？

ドキュメントでは、JavaScript、TypeScript、Python、Java、C#、Go、Rust のドキュメントスタイルについて説明しています。

生成されたすべてのドキュメントを検証しますか？

いいえ。検証ガイダンスは提供しますが、生成されたコンテンツには依然として人によるレビューとツール固有のチェックが必要です。

ネットワークアクセスは必要ですか？

一部のスクリプトは npx を使用して外部の claude-flow ツールを呼び出すため、パッケージがインストールされていない場合はネットワークアクセスが必要になることがあります。

プライベートリポジトリに適していますか？

注意して使用してください。このスキルはプロジェクトファイルをスキャンし、内部 API や設定名を露出するドキュメントを生成する可能性があります。

開発者情報

作成者

DNYoussef

ライセンス

MIT

作者バージョン

v1.0.0

Skillstore リビジョン

リポジトリ

https://github.com/DNYoussef/ai-chrome-extension/tree/main/.claude/skills/documentation/when-documenting-code-use-doc-generator

参照

c579efd02184f1128d6741d16e6c8d951d7d4208

メンテナンスの新しさ

2026/7/18

利用状況

6 ダウンロード · 230 閲覧

ファイル構成

📄 process-diagram.gv

📄 PROCESS.md

📄 README.md

📄 SKILL.md

📄 slash-command-doc-api.sh

📄 slash-command-doc-inline.sh

📄 slash-command-doc-readme.sh

📄 subagent-doc-generator.md