openclaw 网盘下载
OpenClaw

技能详情(站内镜像,无评论)

首页 > 技能库 > api文档生成

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

开发与 DevOps

许可证:MIT-0

MIT-0 ·免费使用、修改和重新分发。无需归因。

版本:v1.0.1

统计:⭐ 0 · 42 · 0 current installs · 0 all-time installs

0

安装量(当前) 0

🛡 VirusTotal :良性 · OpenClaw :良性

Package:dapan0902/doc-pipeline

安全扫描(ClawHub)

  • VirusTotal :良性
  • OpenClaw :良性

OpenClaw 评估

The skill's requirements, runtime instructions, and bundled reference files are consistent with its stated purpose of generating API documentation from Python code and do not request unrelated privileges or external installs.

目的

Name and description match the instruction steps and included template/checklist files; no unrelated credentials, binaries, or installs are requested.

说明范围

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

安装机制

Instruction-only skill with no install spec and no code files to execute; nothing will be downloaded or written by an installer.

证书

No environment variables, credentials, or config paths are requested. Required access (reading the user's Python code) is proportionate to the stated task.

持久

Skill is user-invocable and not always-enabled; it does not request persistent privileges or modifications to other skills or global agent settings.

综合结论

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 hallucinat…

安装(复制给龙虾 AI)

将下方整段复制到龙虾中文库对话中,由龙虾按 SKILL.md 完成安装。

请把本段交给龙虾中文库(龙虾 AI)执行:为本机安装 OpenClaw 技能「api文档生成」。简介:Generates detailed API documentation from Python code by extracting public symb…。
请 fetch 以下地址读取 SKILL.md 并按文档完成安装:https://raw.githubusercontent.com/openclaw/skills/refs/heads/main/skills/dapan0902/doc-pipeline/SKILL.md
(来源:yingzhi8.cn 技能库)

SKILL.md

打开原始 SKILL.md(GitHub raw)

---
name: doc-pipeline
display_name:api文档生成
description: Generates API documentation from Python source code through a multi-step pipeline. Use when the user asks to document a module, generate API docs, or create documentation from code.
metadata:
  pattern: pipeline
  version:1.0.1
  steps: "4"
---

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.