← 返回 Skills 市场
82
总下载
0
收藏
1
当前安装
1
版本数
在 OpenClaw 中安装
/install doc-generator
功能描述
Auto-generates professional README.md from code structure, package.json, and directory analysis. Triggers: generate readme, create readme, readme from code,...
使用说明 (SKILL.md)
README Generator
Overview
Automatically analyzes a codebase and generates a comprehensive, professional README.md.
When to Use
- User asks to "generate a README", "create documentation", or "document this project"
- New project needs a README but none exists
- Existing README is outdated or incomplete
How It Works
Step 1: Analyze project structure
Run: dir /b /s /a:d (Windows) or find . -maxdepth 2 -type d (macOS/Linux)
Step 2: Detect project type
Check for: package.json (JS), setup.py/pyproject.toml (Python), Cargo.toml (Rust), go.mod (Go), pom.xml (Java)
Step 3: Generate README sections
- Project Title - from package.json name or directory name
- Badges - CI status, version, license, downloads
- One-liner Description
- Features - auto-detect from exports and main functions
- Installation - standard install for detected type
- Usage - realistic examples from source code
- API Reference - parse function signatures
- Contributing + License
Output Format
Write a complete README.md with all sections. Keep descriptions under 80 chars per line. Include real badges (shields.io) and actual code examples from the source.
安全使用建议
This skill appears to do what it says — it will scan your repository and create a README from package.json and source code. Before installing or running it: (1) run it first on a non-sensitive test repo to verify output; (2) restrict its input scope or add an allowlist (only src/, package.json, etc.) and explicitly exclude config files, .env, secrets, and private keys; (3) review any generated README before committing or publishing to avoid leaking credentials or internal URLs; (4) prefer skills from known authors or add explicit instructions to the skill for file exclusion and sanitization. If you need higher assurance, request the SKILL.md be expanded to specify exact file paths to read and explicit exclusions.
功能分析
Type: OpenClaw Skill
Name: doc-generator
Version: 1.0.0
The 'doc-generator' skill is a legitimate tool designed to automate the creation of README documentation by analyzing local project structures. It uses standard, read-only system commands (like 'find' or 'dir') and manifest file checks (e.g., package.json) to gather context, showing no signs of malicious intent, data exfiltration, or unauthorized execution in SKILL.md or _meta.json.
能力评估
Purpose & Capability
Name and description match the instructions: SKILL.md explicitly directs examining project directories and files (package.json, source code) and producing README sections (title, installation, usage, API reference). The required capabilities are proportional to the stated goal.
Instruction Scope
Instructions tell the agent to run directory listing commands and to parse package.json and source files to extract function signatures and code examples. That is necessary for README generation, but the instructions are high-level/vague about exactly which files to read and which files to exclude — this grants broad discretion and could cause the agent to read and include sensitive files (config, .env, keys) from the repository. The skill also suggests including externally-hosted badges (shields.io), which implies constructing or referencing external URLs.
Install Mechanism
No install spec and no code files are present (instruction-only). This minimizes disk writes and arbitrary code execution risk.
Credentials
The skill requests no environment variables, credentials, or config paths. Its need to read package.json and source files is proportionate. Still, because it will parse repository files, it can accidentally surface secrets present in the codebase even though it doesn't request credentials explicitly.
Persistence & Privilege
always is false and the skill does not request persistent presence or modifications to other skills or system settings. Autonomous invocation is allowed (platform default) and not itself a red flag here.
如何使用
- 确保已安装 OpenClaw（本地或 Docker 部署）
- 在对话框中输入安装命令：
/install doc-generator - 安装完成后，直接呼叫该 Skill 的名称或使用
/doc-generator触发 - 根据 Skill 的参数说明提供必要输入，即可获得结构化输出
版本历史
v1.0.0
- Initial release of README generator tool.
- Automatically analyzes code structure and project files to produce a professional README.md.
- Detects project type and customizes documentation for JS, Python, Rust, Go, and Java.
- Generates sections including title, badges, description, features, install/usage instructions, API reference, contributing, and license.
- Uses real badges and extracts code examples from the source code.
元数据
常见问题
Doc Generator 是什么？
Auto-generates professional README.md from code structure, package.json, and directory analysis. Triggers: generate readme, create readme, readme from code,... 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件，目前累计下载 82 次。
如何安装 Doc Generator？
在 OpenClaw 或 Claude Code 对话框中运行命令「/install doc-generator」即可一键安装，无需额外配置。
Doc Generator 是免费的吗？
是的，Doc Generator 完全免费，采用 MIT-0 许可证，可自由下载、安装和使用。
Doc Generator 支持哪些平台？
Doc Generator 跨平台运行，可在任意部署了 OpenClaw / Claude Code 的环境中使用（cross-platform）。
谁开发了 Doc Generator？
由 SKY-lv（@sky-lv）开发并维护，当前版本 v1.0.0。
推荐 Skills