技能 documentation-generator

📦

documentation-generator

Name: documentation-generator
Author: CuriousLearner

內容修訂 r1 安全 ⚙️ 外部命令

產生開發人員文件

手動更新文件速度緩慢，且經常與程式碼行為不一致。此技能會引導 Claude、Codex 和 Claude Code 根據原始碼脈絡草擬 docstrings、README 區段和 API 參考文件。

支援: Claude Codex Code(CC)

🥉 78 銅級

Maintain this Skill? Claim it 🥉 78 銅級

使用我的智慧代理安裝

將此請求複製給你的智慧代理，其中包含權威 Skill 頁面和清單。

智能體請求

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

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

Agent 可讀資源

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

Markdown 詳情 GET /skills/curiouslearner-documentation-generator.md 已簽名 manifest GET /api/skills/curiouslearner-documentation-generator/manifest 已簽名 lockfile GET /api/skills/curiouslearner-documentation-generator/lockfile

測試它

正在使用「documentation-generator」。具有 price、tax 和 discount 參數的 TypeScript 工具函式。

預期結果:

一句簡潔的用途說明。
base price、tax rate 和 optional discount 的參數說明。
回傳與錯誤描述，加上一個小型使用範例。

正在使用「documentation-generator」。具有公開方法和拋出例外的 Python 服務類別。

預期結果:

說明主要職責的類別摘要。
包含引數、回傳值和例外的方法文件。
關於附帶影響和預期呼叫端行為的注意事項。

正在使用「documentation-generator」。需要第一份 README 的儲存庫。

預期結果:

給新使用者的專案概述。
安裝、使用方式、設定、API、貢獻和授權區段。
維護者必須驗證之詳細資訊的 placeholder 指引。

安全審計

安全

v8 • 2026/7/6 開啟版本化報告

The flagged external command findings are false positives caused by markdown code fences and example snippets in SKILL.md, not executable shell or Ruby code. The system reconnaissance finding is also a false positive because the cited line is a documentation writing guideline. No prompt injection, exfiltration intent, or hidden execution behavior was found.

已掃描檔案

176

分析行數

複核項目

已忽略的誤報

風險因素

⚙️ 外部命令 (11)

SKILL.md:48-62 SKILL.md:62-65 SKILL.md:65-84 SKILL.md:84-88 SKILL.md:88-94 SKILL.md:94-98 SKILL.md:98-111 SKILL.md:111-113 SKILL.md:113-117 SKILL.md:117-119 SKILL.md:119-134

最近一次完成的靜態與語意稽核未偵測到已確認的安全發現。這並不能證明該 Skill 沒有副作用。

審計單位: codex 檢視審計紀錄 →

分享與引用此報告

分享版本化評估報告、中性徽章、嵌入卡片與引用。Skillstore 只報告證據，不判斷該 Skill 是否安全。

開啟版本化報告

複製報告連結

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

Markdown 徽章

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

HTML 徽章

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

嵌入卡片

<iframe src="https://skillstore.io/embed/skills/curiouslearner-documentation-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 引用

CuriousLearner. (2026). documentation-generator security audit report (audit version 8) [Author version unspecified]. Skillstore. https://skillstore.io/skills/curiouslearner-documentation-generator/audits/8

BibTeX 引用

@techreport{curiouslearner-curiouslearner-documentation-generator-2026,
  author = {CuriousLearner},
  title = {documentation-generator security audit report (audit version 8)},
  institution = {Skillstore},
  year = {2026},
  number = {8},
  url = {https://skillstore.io/skills/curiouslearner-documentation-generator/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-generator security audit report (audit version 8)"
version: "unspecified"
type: report
authors:
  - name: "CuriousLearner"
date-released: "2026-07-06"
url: "https://skillstore.io/skills/curiouslearner-documentation-generator/audits/8"
identifiers:
  - type: other
    value: "skillstore:curiouslearner-documentation-generator:audit:8"
    description: "Skillstore immutable audit report identifier"

Skillstore 評分

評分依據證據置信度: 高

架構

可維護性

內容

社群

規範符合度

你可以打造什麼

記錄工具模組

在程式碼審查前，為函式、參數、回傳值、例外和範例建立一致的註解。

準備專案 README

草擬核心 README 區段，讓貢獻者能夠安裝、使用、設定並擴充專案。

標準化 API 參考文件

將原始碼結構轉換為 SDK、服務或套件的可預期 API 參考區段。

試試這些提示

新增基本 Docstrings

Review the selected functions and draft concise docstrings that explain purpose, parameters, returns, and errors. Keep the existing style.

產生 README 區段

Use the project files I provide to draft a README with overview, installation, usage, configuration, API reference, contributing, and license sections.

符合現有文件風格

Analyze the current documentation style in this repository. Update only missing documentation and preserve custom wording in existing comments.

從原始碼建立 API 參考文件

Build a structured API reference from these modules. Include public classes, methods, parameters, return values, exceptions, side effects, and realistic examples.