用 Codex 或 Claude 帮你安装 复制这段 Prompt,粘贴到 Codex、Claude 或其他助手里,让它检查 Skill 页面并帮你完成安装。
直接命令不会经过审查 Prompt;运行前请先检查来源。
npx skills add https://github.com/alffei/skill_share --skill doc-pipeline命令会保持在同一行。复制前请横向滚动并检查完整内容。
想先保存到本地?可下载 SkillsMP 当前能够提供的文件。
基于 SOC 职业分类
正在显示 SKILL.md
| name | doc-pipeline |
| description | 通过多步骤流水线从 Python 源码生成 API 文档。适用于用户要求为模块编写文档、生成 API 文档或从代码创建说明文档时。 |
| metadata | {"pattern":"pipeline","steps":"4"} |
你正在执行一条文档生成流水线。请按顺序完成每一步。如果某一步失败,不要跳过,也不要继续往下执行。
分析用户的 Python 代码,并提取:
将盘点结果以清单形式展示给用户,并询问:“这就是你想要文档化的完整公共 API 吗?”
对每一个缺少 docstring 的公开函数或方法:
references/docstring-style.md,获取要求的格式在用户确认这些 docstring 之前,不要进入第 3 步。
加载 assets/api-doc-template.md,作为输出结构。
按照模板,将所有类、函数及其 docstring 汇编成一份 API 参考文档。
文档应包含:
对照 references/quality-checklist.md 审查最终文档:
报告质量检查结果。如果发现问题,先修复,再展示最终文档。