← 返回 Skills 市场
Docs Generator
作者
BytesAgain2
· GitHub ↗
· v2.0.0
· MIT-0
439
总下载
0
收藏
1
当前安装
9
版本数
在 OpenClaw 中安装
/install docs-generator
功能描述
Automated documentation generator. API docs, README, CHANGELOG, contributing guide, architecture docs, tutorials, FAQ, reference manual. REST, GraphQL.
使用说明 (SKILL.md)
Docs Generator — Automated Documentation
Spend less time writing docs, more time writing code.
Command Map
┌─ api ──────── REST/GraphQL API documentation
├─ readme ───── Project README.md
├─ changelog ── Version change log
├─ contributing Contributing guide
├─ architecture System architecture docs
├─ tutorial ─── Tutorial / quick start guide
├─ faq ──────── Frequently asked questions
└─ reference ── Complete reference manual
Usage
bash scripts/docs-generator.sh api rest users
bash scripts/docs-generator.sh readme myproject "A cool tool"
bash scripts/docs-generator.sh changelog 2.0.0 "New features"
Arguments
api \x3Ctype> \x3Cresource>— type: rest/graphql, resource namereadme \x3Cname> \x3Cdesc>— project name and descriptionchangelog \x3Cver> \x3Csummary>— version and summarycontributing \x3Cproject>— project namearchitecture \x3Cproject> \x3Cstyle>— style: monolith/microservice/serverlesstutorial \x3Ctopic> \x3Clevel>— level: beginner/intermediate/advancedfaq \x3Ctopic> \x3Ccount>— generate N FAQ entriesreference \x3Clib> \x3Clang>— library name and language
Philosophy
Documentation is a product. Good docs = more users = fewer issues.
💬 Feedback & Feature Requests: https://bytesagain.com/feedback Powered by BytesAgain | bytesagain.com
安全使用建议
This skill appears coherent and limited to generating documentation templates. Before installing or running scripts: (1) verify you are comfortable with a tool creating files under ~/.local/share/docs-generator (or the directory you set via DOCS_GENERATOR_DIR/XDG_DATA_HOME); (2) ensure python3 and bash are available; (3) inspect the included scripts (they are small and readable) and avoid running them as root; and (4) if you need network-free guarantees, note that the current scripts do not perform network calls, but always review future updates for added network behavior.
功能分析
Type: OpenClaw Skill
Name: docs-generator
Version: 2.0.0
The skill bundle is a documentation generator that uses bash and Python to create templates for APIs, READMEs, and other project docs. While it contains a logic bug in `scripts/docs-generator.sh` that prevents custom arguments from being correctly passed to the underlying Python logic (resulting in default templates), and includes an auxiliary unused utility script (`scripts/script.sh`), there are no signs of malicious intent, data exfiltration, or harmful instructions. The scripts operate entirely locally and lack any network or sensitive file access.
能力评估
Purpose & Capability
Name/description match the provided scripts and SKILL.md: the tool generates README, API docs, changelogs, etc. There are no unrelated binaries, credentials, or config paths requested.
Instruction Scope
SKILL.md simply instructs running the included scripts with documented arguments. The scripts generate text templates using local Python and bash and do not read unusual system files, shell history, or transmit data externally.
Install Mechanism
No install spec (instruction-only). The repository includes two small bash scripts that will be executed locally; nothing is downloaded or extracted from external URLs during install.
Credentials
The skill requires no environment variables or credentials. The scripts respect optional DOCS_GENERATOR_DIR/XDG_DATA_HOME/HOME for storing data — these are conventional and proportional to a local utility.
Persistence & Privilege
The helper creates a data directory (default: $XDG_DATA_HOME or $HOME/.local/share/docs-generator) and writes logs/data files there. This is expected for a local utility, but users should be aware it persists small files in their home directory.
如何使用
- 确保已安装 OpenClaw（本地或 Docker 部署）
- 在对话框中输入安装命令：
/install docs-generator - 安装完成后，直接呼叫该 Skill 的名称或使用
/docs-generator触发 - 根据 Skill 的参数说明提供必要输入，即可获得结构化输出
版本历史
v2.0.0
v2.5 standard: Use-when desc, homepage, source, security fix
v2.3.3
yaml-fix+quality
v2.3.2
yaml-fix+quality
v2.3.1
Quality upgrade: custom functionality
v2.3.0
Quality fixes: removed third-party references, aligned docs with implementation
v2.2.0
Enhanced descriptions for better AI triggering
v1.0.2
Runtime fix
v1.0.1
- Removed the tips.md file to clean up and simplify the project.
- No other changes to commands, features, or documentation.
v1.0.0
- Initial release of Docs Generator.
- Automates creation of common project documentation: API docs (REST/GraphQL), README, changelog, contributing guide, architecture docs, tutorials, FAQ, and reference manuals.
- Simple CLI interface with clear command mapping for each documentation type.
- Supports customization for project specifics and doc styles.
元数据
常见问题
Docs Generator 是什么？
Automated documentation generator. API docs, README, CHANGELOG, contributing guide, architecture docs, tutorials, FAQ, reference manual. REST, GraphQL. 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件，目前累计下载 439 次。
如何安装 Docs Generator？
在 OpenClaw 或 Claude Code 对话框中运行命令「/install docs-generator」即可一键安装，无需额外配置。
Docs Generator 是免费的吗？
是的，Docs Generator 完全免费，采用 MIT-0 许可证，可自由下载、安装和使用。
Docs Generator 支持哪些平台？
Docs Generator 跨平台运行，可在任意部署了 OpenClaw / Claude Code 的环境中使用（cross-platform）。
谁开发了 Docs Generator？
由 BytesAgain2（@ckchzh）开发并维护，当前版本 v2.0.0。
推荐 Skills