← 返回 Skills 市场
michealxie001

OpenClaw Doc Generator

作者 michealxie001 · GitHub ↗ · v1.1.0 · MIT-0
cross-platform ✓ 安全检测通过
103
总下载
0
收藏
0
当前安装
1
版本数
在 OpenClaw 中安装
/install oc-docgen
功能描述
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: generate docs and update README. Before using it: 1) Run it in a safe/test copy of your repo first because it writes/overwrites files (docs/, README.md). 2) If you plan to add the suggested CI steps, ensure the CI git push is intentional and that your CI tokens have appropriate scope. 3) Note SKILL.md references a diagram_generator file that isn't present in the bundle and api_generator conditionally imports a 'c-support' module from a nearby path — verify whether that external code exists and is trusted. 4) Review the generated changes (don't auto-commit without inspection). If you want, I can point out the exact lines where files are written and where external imports occur.
功能分析
Type: OpenClaw Skill Name: oc-docgen Version: 1.1.0 The oc-docgen skill bundle is a legitimate documentation generation tool that parses Python and C/C++ source code to create API references, update README tables of contents, and generate architecture diagrams. The code (scripts/api_generator.py, scripts/readme_updater.py, and scripts/main.py) uses standard libraries like 'ast' for code analysis and 're' for text manipulation, with no evidence of data exfiltration, malicious execution, or prompt injection. It includes a graceful fallback for C/C++ support by checking for a sibling 'c-support' directory, which is consistent with a modular skill architecture.
能力评估
Purpose & Capability
Name/description match the included code: CLI entrypoint, API extraction, and README updater. The files and commands shown are what you'd expect for a doc generator.
Instruction Scope
Runtime instructions run local Python scripts that read source files and write documentation and README.md. This is expected, but the skill will modify files in your repo (and the SKILL.md even suggests CI steps that run git push). There are no instructions to read unrelated system credentials or send data to external endpoints.
Install Mechanism
No install spec — instruction-only with bundled scripts. Nothing is downloaded or extracted from external URLs, so install risk is low. The code runs from the skill's scripts when invoked.
Credentials
The skill declares no required environment variables or credentials, which aligns with its purpose. The CI example in SKILL.md includes git push steps (which in practice require CI secrets) — those are just examples but could lead to unexpected pushes if copied verbatim in CI. Also the code conditionally attempts to add a 'c-support' path to sys.path (parent-parent-parent / 'c-support' / 'lib') to import a C parser if present; that may import code from an adjacent directory if it exists.
Persistence & Privilege
always:false (normal). The skill will write/update files in the repository (docs/, README.md). While it doesn't persist as an always-enabled skill or modify other skills, file-write behavior means it can change user content — review changes before committing or enabling automated CI commits.
如何使用
  1. 确保已安装 OpenClaw(本地或 Docker 部署)
  2. 在对话框中输入安装命令:/install oc-docgen
  3. 安装完成后,直接呼叫该 Skill 的名称或使用 /oc-docgen 触发
  4. 根据 Skill 的参数说明提供必要输入,即可获得结构化输出
版本历史
v1.1.0
Added C/C++ support: API documentation generation, Doxygen style support
元数据
Slug oc-docgen
版本 1.1.0
许可证 MIT-0
累计安装 0
当前安装数 0
历史版本数 1
常见问题

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 插件,目前累计下载 103 次。

如何安装 OpenClaw Doc Generator?

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

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.1.0。

💬 留言讨论