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

你的智能体仍应展示其计划，并按安全策略请求必要确认。

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 模式运行，并在编辑前标记有风险的写入。

最佳实践

在干净的分支中运行该技能，并在合并前审查生成的文件。
提供目标文档类型、首选格式和覆盖率目标。
不要在示例中包含密钥，并在发布前替换占位符。

避免

不要对包含未提交关键更改的仓库运行生成脚本。
在检查身份验证和数据暴露之前，不要发布生成的 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/21

使用量

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

DNYoussef 的更多技能

查看全部

📦

slash-command-encoder

为 AI 工作流创建斜杠命令

当用户依赖冗长的自然语言提示时，重复性的 AI 工作流会很慢。此技能可帮助定义简洁的斜杠命令，并支持路由、验证、链式调用和帮助文本。

效率查看

📦

micro-skill-creator

创建聚焦的 AI 微技能

可复用的 AI 工作流常常会变得过于宽泛且难以测试。此技能可帮助定义聚焦的技能，并配备专家提示词、契约和验证计划。

效率查看

📦

cascade-orchestrator

编排多模型技能级联

复杂的 AI 工作通常需要多种技能、模型和质量检查。此技能可帮助设计包含路由、sandbox 测试、swarm 协调和记忆的级联。

编码与开发查看

📦

web-cli-teleport

选择 Claude Code Web 或 CLI

当团队为任务选择了错误的 Claude Code 界面时，会浪费时间。此技能会推荐 Web、CLI 或混合交接工作流。

效率查看

📦

agentdb-semantic-vector-search

构建 AgentDB 语义搜索

团队需要为 RAG 和知识库提供相关的文档检索。此技能指导 AgentDB 设置、嵌入存储、索引、API 搜索和相关性调优。

数据与分析查看

📦

when-creating-presentations-use-pptx-generation

创建无障碍 PowerPoint 演示文稿

手动制作演示文稿可能缓慢且不一致。此技能会引导 Claude、Codex 或 Claude Code 完成结构化 PPTX 生成和验证。

办公与报告查看

查看全部

📦

github-release-assistant

生成双语 GitHub 发布 README

由 ZhanlinCui

当团队需要英文和中文 README 时，发布文档编写会很慢。此技能可根据仓库元数据和引导式配置生成结构化双语 README。

文档查看

📦

repo-docs

文档仓库架构

由 AstraBit-CPT

当依赖项、API 和设置步骤发生变化时，仓库文档往往会过时。此 skill 会分析结构和集成，然后帮助创建 README、API、架构、贡献和集成文档。

文档查看

📦

awesome-repo-builder

构建出色的仓库脚手架

由 zjsxply

创建一份精致的 awesome 列表需要精心设计结构、贡献规则和验证步骤。此技能会根据主题和种子资源生成一个聚焦的仓库脚手架。

文档查看

📦

technical-writer

创建清晰的技术文档

由 shubhamsaboo

团队常常难以将技术细节转化为清晰的文档。此技能可为 Claude、Codex 和 Claude Code 组织 README、API 参考、教程和指南。

文档查看

📦

project-planner

使用结构化文档规划软件项目

由 Dwsy

当需求、设计选择和任务不清晰时，软件项目往往会失败。此技能可将项目想法转化为适用于 Claude、Codex 和 Claude Code 工作流的结构化规划文档。

文档查看

📦

arch-view

可视化服务架构

由 AstraBit-CPT

当元数据分散在多个仓库中时，分布式服务很难理解。此技能会聚合目录元数据，并为架构评审创建图表、表格和摘要。

文档查看

when-documenting-code-use-doc-generator

使用我的智能体安装

Agent 可读资源

测试它

安全审计

已确认安全问题 (2)

风险因素

复制报告链接

Markdown 徽章

HTML 徽章

嵌入卡片

APA 引用

BibTeX 引用

CITATION.cff

Skillstore 评分

你能构建什么

为后端 API 编写文档

刷新项目入门文档

提升代码注释覆盖率

试试这些提示

最佳实践

避免

常见问题

开发者详情

DNYoussef 的更多技能

slash-command-encoder

micro-skill-creator

cascade-orchestrator

web-cli-teleport

agentdb-semantic-vector-search

when-creating-presentations-use-pptx-generation

相关技能

github-release-assistant

repo-docs

awesome-repo-builder

technical-writer

project-planner

arch-view