← Back to Skills Marketplace
96
Downloads
0
Stars
0
Active Installs
1
Versions
Install in OpenClaw
/install oc-doc-generator
Description
从源代码自动生成 API 文档、技术文档，支持输出到飞书云文档。包含代码注释提取、 中文文档模板、OpenAPI 规范生成等功能。 **触发场景**： - 用户要求"生成文档"、"写 API 文档"、"自动生成文档" - 需要从代码提取注释生成文档 - 需要输出文档到飞书 - 用户提到"API 文档"、"接口文档...
Usage Guidance
This skill appears to do what it says: parse source code and generate API docs, optionally sending them to Feishu using another skill. Before installing or running it: 1) Review extract_api.py fully (especially the parts not shown here) to confirm it has no network calls, telemetry, or attempts to read unrelated system paths. 2) Be explicit about what code/directories you allow it to analyze — the tool reads your source files and can include snippets in generated docs. 3) Confirm how Feishu uploads will be authenticated (which skill will hold Feishu tokens and where those tokens are stored). 4) Run the script in a sandbox or on a copy of your repository first to validate outputs and ensure no secrets are leaked into generated examples. If you want extra assurance, ask for a full code review of extract_api.py (complete file) and any invoked helper skills (feishu-create-doc).
Capability Analysis
Type: OpenClaw Skill
Name: oc-doc-generator
Version: 1.0.0
The skill bundle is a legitimate tool for generating API documentation from source code. The primary component, `scripts/extract_api.py`, uses safe static analysis techniques (Python's `ast` module and regular expressions) to parse Python, JavaScript, and Go files. The instructions in `SKILL.md` are consistent with the stated purpose of documentation generation and integration with Feishu (Lark) docs, without any evidence of malicious intent, data exfiltration, or harmful prompt injection.
Capability Assessment
Purpose & Capability
Name/description match the included script and instructions: extract_api.py and SKILL.md focus on parsing source code to produce Markdown/JSON/OpenAPI and optionally send output to Feishu. The only mild inconsistency is that SKILL.md references a separate feishu-create-doc skill for Feishu upload but does not declare that dependency explicitly — functionality still coherent with the stated purpose.
Instruction Scope
Runtime instructions explicitly tell the agent to read source files/directories and extract signatures/docstrings — this is required for a doc generator and is expected. Be aware this grants the skill access to your repository/source files when invoked; SKILL.md does not instruct reading unrelated system files or environment variables. It also instructs calling an external 'feishu-create-doc' skill to upload docs to Feishu (an external endpoint), which is expected but should be authorized separately.
Install Mechanism
No install spec; instruction-only with a provided Python script. No downloads, package installs, or archive extraction are declared, so there is low install-time risk. The included Python script appears self-contained and reads local files.
Credentials
Skill declares no required environment variables or credentials (reasonable). However, to actually upload to Feishu the agent/platform will need Feishu credentials (not declared here) or the separate feishu-create-doc skill must have appropriate auth — confirm where Feishu tokens are stored and which skill will use them. Also confirm that your codebase does not contain secrets (tokens/API keys) that the extractor might capture in examples or doc fragments.
Persistence & Privilege
Skill does not request always:true and doesn't request persistent system privileges. It will read project files when invoked, which is appropriate for its purpose. Autonomous invocation is allowed (platform default) but not by itself a problem; combine caution with the notes above about repo access and Feishu uploads.
How to Use
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install oc-doc-generator - After installation, invoke the skill by name or use
/oc-doc-generator - Provide required inputs per the skill's parameter spec and get structured output
Version History
v1.0.0
v1.0.0 - API文档自动生成，支持Python/JS/Go，飞书文档输出
Metadata
Frequently Asked Questions
What is OC Doc Generator?
从源代码自动生成 API 文档、技术文档，支持输出到飞书云文档。包含代码注释提取、 中文文档模板、OpenAPI 规范生成等功能。 **触发场景**： - 用户要求"生成文档"、"写 API 文档"、"自动生成文档" - 需要从代码提取注释生成文档 - 需要输出文档到飞书 - 用户提到"API 文档"、"接口文档... It is an AI Agent Skill for Claude Code / OpenClaw, with 96 downloads so far.
How do I install OC Doc Generator?
Run "/install oc-doc-generator" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is OC Doc Generator free?
Yes, OC Doc Generator is completely free, licensed under MIT-0. You can download, install and use it at no cost.
Which platforms does OC Doc Generator support?
OC Doc Generator is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created OC Doc Generator?
It is built and maintained by Narain (@penghang1223); the current version is v1.0.0.
More Skills