技能 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 差

Maintain this Skill? Claim it ⚠️ 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.

你的智慧代理仍應顯示其計畫，並依安全政策請求必要確認。

Agent 可讀資源

當 AI Agent、爬蟲或腳本需要乾淨脈絡、而不是讀取完整頁面時，請使用這些連結。

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

可維護性

內容

社群

規範符合度

你可以打造什麼

記錄後端 API

為服務儲存庫產生 OpenAPI 風格的參考資料、端點摘要、驗證注意事項和使用範例。

更新專案入門文件

根據儲存庫中繼資料建立 README，包含設定、配置、測試、貢獻和支援章節。

改善程式碼註解覆蓋率

識別未記錄的函式，並為支援的語言風格建立行內註解指引。

試試這些提示

產生基本文件

使用此技能檢閱目前的儲存庫，並產生基本 README 和 API 文件。保持輸出精簡，並列出變更的檔案。

建立 API 參考資料

使用此技能記錄此專案中的 REST API。包含端點、請求格式、回應摘要、驗證注意事項和驗證警告。

新增行內註解

使用此技能尋找 src 中未記錄的公開函式。新增或提出 JSDoc、TSDoc 或 Python docstrings，並避免變更業務邏輯。

建立完整文件集

使用此技能產生 README、API 參考資料、架構筆記、行內註解建議和文件缺口報告。可行時以 dry-run 模式執行，並在編輯前標記有風險的寫入。

最佳實務

在乾淨的分支中執行此技能，並在合併前審閱產生的檔案。
提供目標文件類型、偏好的格式和覆蓋率目標。
避免在範例中包含機密資訊，並在發布前替換佔位符。

避免

不要對含有未提交關鍵變更的儲存庫執行產生 scripts。
在檢查驗證和資料暴露前，不要發布產生的 API 詳細資訊。
不要在未驗證的情況下假設範例可用於正式環境。

常見問題

此技能會編輯專案檔案嗎？

是。內含的 scripts 可以建立 README 和 docs 輸出，因此提交前請先審閱變更。

它可以產生 OpenAPI 文件嗎？

可以。此技能包含 API 文件工作流程，可產生 OpenAPI 風格的參考資料和端點摘要。

此技能描述了哪些語言？

文件描述了 JavaScript、TypeScript、Python、Java、C#、Go 和 Rust 的文件風格。

它會驗證每個產生的文件嗎？

不會。它提供驗證指引，但產生的內容仍需要人工審閱和工具特定檢查。

它需要網路存取嗎？

部分 scripts 會使用 npx 呼叫外部 claude-flow tooling；如果套件尚未安裝，可能需要網路存取。

它適合用於私人儲存庫嗎？

請謹慎使用。此技能會掃描專案檔案，並可能產生暴露內部 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