doc-generator
生成 Python 文档
Python 项目通常缺少最新的 API 文档。此技能可帮助 Claude、Codex 或 Claude Code 基于源代码结构、docstrings 和 type hints 创建 Markdown 文档。
使用我的智能体安装
将此请求复制给你的智能体，其中包含权威 Skill 页面和清单。
Review the Skillstore skill "doc-generator" from https://skillstore.io/skills/bossjones-doc-generator.md and its manifest at https://skillstore.io/api/skills/bossjones-doc-generator/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.你的智能体仍应展示其计划，并按安全策略请求必要确认。
Agent 可读资源
当 AI Agent、爬虫或脚本需要干净上下文，而不是读取完整页面时，请使用这些链接。
测试它
正在使用“doc-generator”。 用户将该技能指向一个包含公共类、方法和 docstrings 的 Python 模块。
预期结果:
一份 Markdown API 参考，包含模块摘要、类章节、方法签名、参数说明、返回值描述和用法说明。
正在使用“doc-generator”。 用户请求从一个小型 Python 包生成 README 内容。
预期结果:
一个可直接用于 README 的章节，包含包概述、公共 API 摘要、常见用法指导，以及关于缺失描述的警告。
正在使用“doc-generator”。 用户请求为发布分支生成文档覆盖率报告。
预期结果:
一份文档报告，列出已生成章节、缺失的 docstrings、不完整的参数细节和建议修复项。
安全审计
安全All eight static findings are false positives caused by Markdown fences or inline code formatting in SKILL.md. The skill contains no shell commands, prompt injection, network instructions, or semantic evidence of malicious intent.
风险因素
分享与引用此报告
分享版本化评估报告、中性徽章、嵌入卡片和引用。Skillstore 只报告证据，不判断该 Skill 是否安全。
复制报告链接
https://skillstore.io/skills/bossjones-doc-generator/audits/9?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportMarkdown 徽章
[](https://skillstore.io/skills/bossjones-doc-generator?utm_source=security_passport_badge)HTML 徽章
<a href="https://skillstore.io/skills/bossjones-doc-generator?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/bossjones-doc-generator/security.svg" alt="Skillstore security assessment" loading="lazy"></a>嵌入卡片
<iframe src="https://skillstore.io/embed/skills/bossjones-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 引用
bossjones. (2026). doc-generator security audit report (audit version 9) [Author version unspecified]. Skillstore. https://skillstore.io/skills/bossjones-doc-generator/audits/9BibTeX 引用
@techreport{bossjones-bossjones-doc-generator-2026,
author = {bossjones},
title = {doc-generator security audit report (audit version 9)},
institution = {Skillstore},
year = {2026},
number = {9},
url = {https://skillstore.io/skills/bossjones-doc-generator/audits/9},
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: "doc-generator security audit report (audit version 9)"
version: "unspecified"
type: report
authors:
- name: "bossjones"
date-released: "2026-07-23"
url: "https://skillstore.io/skills/bossjones-doc-generator/audits/9"
identifiers:
- type: other
value: "skillstore:bossjones-doc-generator:audit:9"
description: "Skillstore immutable audit report identifier"
Skillstore 评分
评分依据 证据置信度: 高你能构建什么
记录 Python 包文档
基于包模块、类、方法和函数创建结构化的 Markdown API 参考。
刷新项目 README
生成 README 章节，用于总结公共 API、用法示例和可用的类型签名。
准备内部 API 笔记
将服务或实用工具模块转换为可读文档，用于交接、入职或评审。
试试这些提示
为这个 Python 文件生成 Markdown 文档。包含模块摘要、公共类、公共函数、参数、返回值，并对缺失的 docstrings 给出清晰警告。
为这个 Python 包生成 API 文档。处理公共模块，按模块分组输出，包含类和函数签名，并添加目录。
使用当前 Python 源代码更新现有 Markdown 文档。尽可能保留当前结构，刷新过时的签名，并标注未记录文档的公共成员。
审查这个 Python 代码库的文档覆盖率。生成 Markdown API 文档，识别缺失或薄弱的 docstrings，并推荐最高优先级的文档修复项。
最佳实践
- 在包含最新 docstrings 和 type hints 的干净源文件上运行它。
- 对于不受信任的仓库，优先使用基于 AST 的解析。
- 在发布给用户之前审查生成的示例。
避免
- 不要依赖生成的文档来替代准确的源代码注释。
- 不要在没有隔离的情况下对不受信任的 Python 使用运行时检查。
- 不要在未检查公共成员与私有成员区别的情况下发布生成的 API 文档。