메뉴
通过多步骤流水线从 Python 源码生成 API 文档。适用于用户要求为模块编写文档、生成 API 文档或从代码创建说明文档时。
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
SOC 직업 분류 기준
FastAPI 开发最佳实践与约定。适用于编写、审查或排查 FastAPI 应用、REST API 或 Pydantic 模型时。
审查 Python 代码的质量、风格和常见缺陷。适用于用户提交代码要求审查、希望获得反馈或进行代码审计时。
先通过结构化提问收集需求，再输出软件项目规划。适用于用户说“我想做……”“帮我规划……”“设计一个系统”或“启动一个新项目”时。
生成结构化技术报告（Markdown）。适用于用户要求撰写、创建或起草报告、总结或分析文档时。
Use for querying Google NotebookLM notebooks from Codex via local browser automation. Trigger when the user mentions NotebookLM, shares a NotebookLM URL, wants source-grounded answers from uploaded docs, or needs to add, list, search, activate, or remove notebooks from a local NotebookLM library.
draw.io diagram creation, editing, and review. Use for .drawio XML editing, PNG conversion, layout adjustment, and AWS icon usage.
| 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 审查最终文档：
报告质量检查结果。如果发现问题，先修复，再展示最终文档。