alffei/doc-pipeline
adk-skill-design-patterns-zh/skills/doc-pipeline/SKILL.md
通过多步骤流水线从 Python 源码生成 API 文档。适用于用户要求为模块编写文档、生成 API 文档或从代码创建说明文档时。
$ install --global
skillsauthnpx skillsauth add alffei/skill_share doc-pipelineInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: Apr 3, 2026, 2:37 PM5.7s4 files scanned
SKILL.md
- name:
- doc-pipeline
- description:
- 通过多步骤流水线从 Python 源码生成 API 文档。适用于用户要求为模块编写文档、生成 API 文档或从代码创建说明文档时。
- pattern:
- pipeline
- steps:
- 4
你正在执行一条文档生成流水线。请按顺序完成每一步。如果某一步失败，不要跳过，也不要继续往下执行。
第 1 步 - 解析与盘点
分析用户的 Python 代码，并提取：
- 所有公开类及其方法
- 所有公开函数
- 所有模块级常量
- 已有的 docstring（并标注哪些缺失）
将盘点结果以清单形式展示给用户，并询问：“这就是你想要文档化的完整公共 API 吗？”
第 2 步 - 生成 Docstring
对每一个缺少 docstring 的公开函数或方法：
- 加载
references/docstring-style.md，获取要求的格式 - 严格按照风格规范生成 docstring
- 将生成的 docstring 展示给用户审批
在用户确认这些 docstring 之前，不要进入第 3 步。
第 3 步 - 组装文档
加载 assets/api-doc-template.md，作为输出结构。
按照模板，将所有类、函数及其 docstring 汇编成一份 API 参考文档。
文档应包含：
- 带锚点链接的目录
- 每个类或函数各自独立的小节
- 每项对应的参数、返回类型和使用示例
第 4 步 - 质量检查
对照 references/quality-checklist.md 审查最终文档：
- 每个公开符号都已经写入文档
- 每个参数都有类型和说明
- 每个函数至少包含一个使用示例
- 文中不再残留占位文本
报告质量检查结果。如果发现问题，先修复，再展示最终文档。
Related Skills
alffei/writing-wechat-tech-posts
testing
VerifiedTrustedCommunity
Writes complete WeChat tech posts (hook, TOC, body, checklists, image placement, layout notes, summaries). Use when the user asks to draft a WeChat tech article, generate reusable prompts for writing, or turn a topic/outline into a publish-ready post.
60SKILL.mdUpdated Apr 3, 2026
alffei/titling-wechat-tech-posts
tools
VerifiedTrustedCommunity
Crafts and rewrites WeChat tech post titles across multiple patterns (list, contrast, outcome, scenario, anti-myth, template). Use when the user needs headline brainstorming or “restrained but clickable” title rewrites for tech/engineering WeChat公众号.
60SKILL.mdUpdated Apr 3, 2026
alffei/planning-wechat-tech-account
content-media
VerifiedTrustedCommunity
Defines WeChat tech public-account positioning, audience segmentation, content pillars, and long-term columns. Use when the user asks about account positioning, reader personas, content strategy, or column planning for a tech/engineering WeChat公众号.
60SKILL.mdUpdated Apr 3, 2026
alffei/outlining-wechat-tech-posts
development
VerifiedTrustedCommunity
Builds WeChat-friendly outlines for tech posts, including multi-level TOC, reader-benefit lines per section, pitfalls and action checklists, and 30-second skim summaries. Use when the user asks for outlines, structures, or tutorial-style blueprints for tech/engineering WeChat公众号.
60SKILL.mdUpdated Apr 3, 2026