← 返回 Skills 市场
dapan0902

api文档生成

作者 dapan0902 · GitHub ↗ · v1.0.1 · MIT-0
cross-platform ✓ 安全检测通过
173
总下载
0
收藏
0
当前安装
2
版本数
在 OpenClaw 中安装
/install doc-pipeline
功能描述
Generates detailed API documentation from Python code by extracting public symbols, adding standardized docstrings, assembling, and quality-checking the docs.
使用说明 (SKILL.md)

You are running a documentation generation pipeline. Execute each step in order. Do NOT skip steps or proceed if a step fails.

Step 1 — Parse & Inventory

Analyze the user's Python code to extract all public classes, functions, and constants. Present the inventory as a checklist. Ask: "Is this the complete public API you want documented?"

Step 2 — Generate Docstrings

For each function lacking a docstring:

  • Load 'references/docstring-style.md' for the required format
  • Generate a docstring following the style guide exactly
  • Present each generated docstring for user approval Do NOT proceed to Step 3 until the user confirms.

Step 3 — Assemble Documentation

Load 'assets/api-doc-template.md' for the output structure. Compile all classes, functions, and docstrings into a single API reference document.

Step 4 — Quality Check

Review against 'references/quality-checklist.md':

  • Every public symbol documented
  • Every parameter has a type and description
  • At least one usage example per function Report results. Fix issues before presenting the final document.
安全使用建议
This skill appears coherent and low-risk: it only uses internal templates and asks to analyze the user's Python code to produce docs. Before installing, confirm the agent will have access to the correct codebase (repository or files). Also review generated docstrings and examples for correctness and to ensure no sensitive data from your code (secrets, credentials, or internal endpoints) is inadvertently included in the docs—LLMs can hallucinate types/examples, so a manual review step is recommended.
功能分析
Type: OpenClaw Skill Name: doc-pipeline Version: 1.0.1 The skill bundle is a standard documentation generation pipeline designed to parse Python code and generate API references. The instructions in SKILL.md follow a logical, multi-step process involving user confirmation and the use of local template/style files (assets/api-doc-template.md, references/docstring-style.md). There are no indicators of data exfiltration, malicious execution, or prompt-injection attacks.
能力评估
✓ Purpose & Capability
Name and description match the instruction steps and included template/checklist files; no unrelated credentials, binaries, or installs are requested.
✓ Instruction Scope
SKILL.md describes a clear 4-step pipeline that operates on the user's Python source and internal reference files. It does not instruct reading unrelated system files, environment variables, or contacting external endpoints. Note: the pipeline assumes the agent has access to the user's code (expected for this purpose).
✓ Install Mechanism
Instruction-only skill with no install spec and no code files to execute; nothing will be downloaded or written by an installer.
✓ Credentials
No environment variables, credentials, or config paths are requested. Required access (reading the user's Python code) is proportionate to the stated task.
✓ Persistence & Privilege
Skill is user-invocable and not always-enabled; it does not request persistent privileges or modifications to other skills or global agent settings.
如何使用
  1. 确保已安装 OpenClaw（本地或 Docker 部署）
  2. 在对话框中输入安装命令：/install doc-pipeline
  3. 安装完成后，直接呼叫该 Skill 的名称或使用 /doc-pipeline 触发
  4. 根据 Skill 的参数说明提供必要输入，即可获得结构化输出
版本历史
v1.0.1
1.一套完整的软件开发生命周期（SDLC）辅助工具链中的一环【api-expert】 2.总共包括 - 5 个 Skill（api-expert、report-generator-new、code-reviewer-new、project-planner-new、doc-pipeline） 3.完整的可以把这5个skil下载，即可形成闭环
v1.0.0
Initial release of doc-pipeline skill. - Generates API documentation from Python source code using a four-step pipeline. - Interactive workflow: inventory public symbols, generate docstrings, assemble documentation, and run a quality check. - Ensures user review at each stage before proceeding. - Applies consistent docstring style and template-based formatting. - Focuses on thorough, accurate, and well-structured API documentation.
元数据
Slug doc-pipeline
版本 1.0.1
许可证 MIT-0
累计安装 0
当前安装数 0
历史版本数 2
常见问题

api文档生成 是什么？

Generates detailed API documentation from Python code by extracting public symbols, adding standardized docstrings, assembling, and quality-checking the docs. 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件，目前累计下载 173 次。

如何安装 api文档生成？

在 OpenClaw 或 Claude Code 对话框中运行命令「/install doc-pipeline」即可一键安装，无需额外配置。

api文档生成 是免费的吗？

是的，api文档生成 完全免费，采用 MIT-0 许可证，可自由下载、安装和使用。

api文档生成 支持哪些平台？

api文档生成 跨平台运行，可在任意部署了 OpenClaw / Claude Code 的环境中使用（cross-platform）。

谁开发了 api文档生成？

由 dapan0902（@dapan0902）开发并维护，当前版本 v1.0.1。

推荐 Skills
self-improving agent
Captures learnings, errors, and corrections to enable continuous improvement. Use when: (1) A command or operation fails unexpectedly, (2) User corrects Clau...
⬇ 463283 · by pskoett
Skill Vetter
Security-first skill vetting for AI agents. Use before installing any skill from ClawdHub, GitHub, or other sources. Checks for red flags, permission scope, and suspicious patterns.
⬇ 259410 · by spclaudehome
Polymarket
Query Polymarket prediction markets. Check odds, find trending markets, search events, track price movements.
⬇ 232503 · by joelchance
Self-Improving + Proactive Agent
Self-reflection + Self-criticism + Self-learning + Self-organizing memory. Agent evaluates its own work, catches mistakes, and improves permanently. Use when...
⬇ 200423 · by ivangdavila
Github
Interact with GitHub using the `gh` CLI. Use `gh issue`, `gh pr`, `gh run`, and `gh api` for issues, PRs, CI runs, and advanced queries.
⬇ 191113 · by steipete
ontology
Typed knowledge graph for structured agent memory and composable skills. Use when creating/querying entities (Person, Project, Task, Event, Document), linkin...
⬇ 190156 · by oswalpalash

💬 留言讨论