← Back to Skills Marketplace

api文档生成

Name: api文档生成
Author: dapan0902

by dapan0902 · GitHub ↗ · v1.0.1 · MIT-0

cross-platform ✓ Security Clean

173

Downloads

Stars

Active Installs

Versions

Install in OpenClaw

/install doc-pipeline

Description

Generates detailed API documentation from Python code by extracting public symbols, adding standardized docstrings, assembling, and quality-checking the docs.

README (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.

Usage Guidance

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.

Capability Analysis

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.

Capability Assessment

✓ 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.

How to Use

Make sure OpenClaw is installed (local or Docker)
Run the install command in chat: /install doc-pipeline
After installation, invoke the skill by name or use /doc-pipeline
Provide required inputs per the skill's parameter spec and get structured output

Version History

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.

Metadata

Slug doc-pipeline

Version 1.0.1

License MIT-0

All-time Installs 0

Active Installs 0

Total Versions 2

Frequently Asked Questions

What is api文档生成?

Generates detailed API documentation from Python code by extracting public symbols, adding standardized docstrings, assembling, and quality-checking the docs. It is an AI Agent Skill for Claude Code / OpenClaw, with 173 downloads so far.

How do I install api文档生成?

Run "/install doc-pipeline" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.

Is api文档生成 free?

Yes, api文档生成 is completely free, licensed under MIT-0. You can download, install and use it at no cost.

Which platforms does api文档生成 support?

api文档生成 is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).

Who created api文档生成?

It is built and maintained by dapan0902 (@dapan0902); the current version is v1.0.1.

More Skills