← 返回 Skills 市场
OpenClaw Doc Generator
作者
michealxie001
· GitHub ↗
· v1.0.0
· MIT-0
113
总下载
0
收藏
0
当前安装
1
版本数
在 OpenClaw 中安装
/install openclaw-doc-gen
功能描述
Generates documentation from code. Creates API docs, README updates, architecture diagrams, and keeps documentation in sync with code changes.
安全使用建议
This skill appears to do what it says: it scans Python source and updates/creates documentation and the README. Before installing or running it, (1) understand it will write to your repository (README.md and docs/), so commit/back up changes or run in a throwaway clone; (2) review the included scripts yourself—particularly readme_updater.py which overwrites README sections—to ensure the TOC/API insertion behavior matches your expectations; (3) note a minor inconsistency: SKILL.md mentions a diagram_generator.py file and CI paths that are not present in the provided manifest—verify whether additional files are missing or paths in your CI must be adjusted; (4) because the tool writes files, run it locally first (not on production branches) and inspect changes before pushing; and (5) no credentials or network calls were found, so there is no immediate secret-exfiltration risk in the provided code, but always review any future updates for added networking or credential access.
功能分析
Type: OpenClaw Skill
Name: openclaw-doc-gen
Version: 1.0.0
The skill bundle is a legitimate documentation generator that uses Python's 'ast' module to parse source code and generate Markdown documentation. The code (api_generator.py, readme_updater.py, main.py) relies solely on the Python standard library, contains no dangerous execution sinks like eval() or subprocess, and performs no network or sensitive file access. The instructions in SKILL.md are consistent with the tool's functionality and do not contain prompt injection or malicious directives.
能力评估
Purpose & Capability
The name/description (doc generation, README updates, diagrams, sync checks) align with the included scripts: api_generator.py, readme_updater.py, and main.py implement API docs generation, README modification, diagram printing, and sync checks. No unrelated credentials, binaries, or config paths are requested.
Instruction Scope
SKILL.md instructs running the included scripts (python3 scripts/main.py ...). The scripts legitimately read source files and write docs/ and README.md. This is expected, but note: the skill will modify repository files (README.md, docs/*). The SKILL.md also references a diagram_generator.py and a CI path 'skills/documentation-generator/scripts/main.py' that do not match the provided manifest (scripts/diagram_generator.py is not present), which is an inconsistency to verify.
Install Mechanism
No install spec provided; this is an instruction-only skill that runs local Python scripts. No network downloads or external package installs are performed by the skill itself.
Credentials
The skill declares no required environment variables, credentials, or config paths. The code does not attempt to read environment secrets or external credential files. Its file I/O is limited to repository files under the provided root.
Persistence & Privilege
always is false and there is no code that modifies other skills or system-wide agent settings. The skill will write files in the repository (docs/, README.md) which is expected for a documentation tool, but it does not request persistent platform privileges.
如何使用
- 确保已安装 OpenClaw(本地或 Docker 部署)
- 在对话框中输入安装命令:
/install openclaw-doc-gen - 安装完成后,直接呼叫该 Skill 的名称或使用
/openclaw-doc-gen触发 - 根据 Skill 的参数说明提供必要输入,即可获得结构化输出
版本历史
v1.0.0
Generate API documentation from Python code, update README, and check doc sync
元数据
常见问题
OpenClaw Doc Generator 是什么?
Generates documentation from code. Creates API docs, README updates, architecture diagrams, and keeps documentation in sync with code changes. 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件,目前累计下载 113 次。
如何安装 OpenClaw Doc Generator?
在 OpenClaw 或 Claude Code 对话框中运行命令「/install openclaw-doc-gen」即可一键安装,无需额外配置。
OpenClaw Doc Generator 是免费的吗?
是的,OpenClaw Doc Generator 完全免费,采用 MIT-0 许可证,可自由下载、安装和使用。
OpenClaw Doc Generator 支持哪些平台?
OpenClaw Doc Generator 跨平台运行,可在任意部署了 OpenClaw / Claude Code 的环境中使用(cross-platform)。
谁开发了 OpenClaw Doc Generator?
由 michealxie001(@michealxie001)开发并维护,当前版本 v1.0.0。
推荐 Skills