← 返回 Skills 市场
Code Documentor
作者
rupertnt034
· GitHub ↗
· v1.0.0
· MIT-0
231
总下载
0
收藏
0
当前安装
1
版本数
在 OpenClaw 中安装
/install rupert-code-documentor
功能描述
Automatically generate detailed and convention-compliant documentation for codebases in multiple languages, including README, API docs, and function comments.
安全使用建议
This skill appears coherent and doesn't request credentials or perform installs, but it will need access to your codebase to generate docs. Before using it: (1) run it on a copy or limit the requested files/directories to avoid exposing secrets; (2) review generated documentation for accidental inclusion of private data (keys, tokens, internal paths); (3) confirm license and third-party attribution in generated READMEs and API docs; and (4) if you allow autonomous runs, consider restricting its scope or confirming each run so it doesn't scan the entire repository automatically.
功能分析
Type: OpenClaw Skill
Name: rupert-code-documentor
Version: 1.0.0
The skill bundle is a standard documentation generation tool for an AI agent. It contains only metadata and markdown instructions (SKILL.md) defining templates and commands for creating READMEs and API documentation, with no executable code, network requests, or suspicious prompt-injection attempts.
能力评估
Purpose & Capability
Name and description match the SKILL.md content: templates, supported languages, and commands are all consistent with a code documentation generator. There are no unrelated environment variables, binaries, or config paths requested.
Instruction Scope
SKILL.md gives templates and user-facing commands (e.g., 'document this code', 'generate README for [project]'). It does not instruct the agent to contact external endpoints or access system-wide credentials, but it is somewhat vague about which files or directories to operate on and does not include guidance to avoid secrets or large-scale repository scanning. This grants the agent normal discretionary access to the repository/workspace when invoked — expected for this type of skill, but users should limit scope when running it.
Install Mechanism
Instruction-only skill with no install spec and no code files — nothing is written to disk by an installer, which minimizes install-time risk.
Credentials
No environment variables, credentials, or config paths are requested. The lack of secret requests is appropriate for a document-generation skill.
Persistence & Privilege
always is false and the skill does not request persistent or elevated privileges. Autonomous invocation is allowed by platform default but the skill itself does not demand extra system presence or modify other skills.
如何使用
- 确保已安装 OpenClaw（本地或 Docker 部署）
- 在对话框中输入安装命令：
/install rupert-code-documentor - 安装完成后，直接呼叫该 Skill 的名称或使用
/rupert-code-documentor触发 - 根据 Skill 的参数说明提供必要输入，即可获得结构化输出
版本历史
v1.0.0
- Initial release of Code Documentor Skill.
- Automatically generates documentation for codebases in multiple languages, including Python, JavaScript/TypeScript, Swift, Go, Rust, and Java.
- Supports creation of project READMEs, API references, architecture docs, contributing guides, and changelogs.
- Provides commands for documenting code, functions, endpoints, and generating custom documentation files.
- Includes templates for READMEs and function documentation.
- Configuration options for documentation style, inclusion of examples, target language, and output format.
元数据
常见问题
Code Documentor 是什么？
Automatically generate detailed and convention-compliant documentation for codebases in multiple languages, including README, API docs, and function comments. 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件，目前累计下载 231 次。
如何安装 Code Documentor？
在 OpenClaw 或 Claude Code 对话框中运行命令「/install rupert-code-documentor」即可一键安装，无需额外配置。
Code Documentor 是免费的吗？
是的，Code Documentor 完全免费，采用 MIT-0 许可证，可自由下载、安装和使用。
Code Documentor 支持哪些平台？
Code Documentor 跨平台运行，可在任意部署了 OpenClaw / Claude Code 的环境中使用（cross-platform）。
谁开发了 Code Documentor？
由 rupertnt034（@rupertnt034）开发并维护，当前版本 v1.0.0。
推荐 Skills