← 返回 Skills 市场
project-docs-generator
作者
LeoNardo-LB
· GitHub ↗
· v1.0.0
· MIT-0
113
总下载
0
收藏
0
当前安装
1
版本数
在 OpenClaw 中安装
/install project-docs-generator
功能描述
智能分析代码库并生成定制化文档系统。当用户需要：(1) 为新项目创建文档 (2) 补全现有项目文档 (3) 生成技术文档目录结构 (4) 创建架构设计文档 (5) 编写API文档或开发指南时触发此技能。支持任意技术栈和项目结构（纯前端、纯后端、全栈、微服务、monorepo、库/SDK等），自动识别项目特点并生成...
安全使用建议
This skill appears internally consistent and implements the described functionality. Before installing or running it, consider: 1) Review the three Python scripts (analyze_codebase.py, init_docs.py, validate_plantuml.py) yourself — they are plain readable code and perform filesystem operations under the provided project path. 2) Run the tool in an isolated environment (container or VM) if you will analyze repositories that may contain secrets or proprietary code. The analyzer will parse config and dependency files (which sometimes contain credentials); the SKILL.md also recommends 'on-demand network searches' — decide whether the agent should be allowed to make external requests (this can leak snippets or metadata). 3) validate_plantuml.py warns about external !include directives in PlantUML; if your docs reference external includes, inspect those references. 4) If you need stricter privacy, disable web access for the agent or restrict the skill to local-only analysis. Overall: coherent and purposeful, but exercise standard caution around running code that scans repositories and can reach the network.
功能分析
Type: OpenClaw Skill
Name: project-docs-generator
Version: 1.0.0
The 'project-docs-generator' skill is a legitimate tool designed to automate the analysis of codebases and the generation of technical documentation. The included Python scripts (analyze_codebase.py, init_docs.py, and validate_plantuml.py) perform standard file system operations to identify technology stacks and initialize templates, with no evidence of malicious execution, data exfiltration, or obfuscation. The instructions in SKILL.md are clearly aligned with the stated purpose, providing a structured workflow for the AI agent to follow without any harmful prompt-injection patterns.
能力评估
Purpose & Capability
The name/description (project documentation generation) aligns with included assets: analyze_codebase.py (scans repo and detects tech stack), init_docs.py (creates docs directory and templates), and validate_plantuml.py (validates PlantUML blocks). There are supporting reference docs describing structure and detection rules, so required capabilities are proportionate to the stated purpose.
Instruction Scope
SKILL.md explicitly instructs scanning the project root, parsing dependency/config files, extracting entry points, and performing '按需网络检索' (on-demand web searches when unfamiliar frameworks appear). Scanning project files (including config files) is appropriate for the stated goal, but the web-retrieval guidance means the agent may contact external sites and could (depending on agent behavior) expose code snippets or config data during searches. The instructions do not direct exfiltration to unexpected endpoints, but they do give broad discretion to perform internet lookups.
Install Mechanism
There is no install spec (instruction-only behavior) and all code is delivered as plain Python scripts in the skill bundle; nothing is downloaded from arbitrary URLs and no archives are extracted. This is low install risk.
Credentials
The skill requests no environment variables or external credentials. However, the analyzer intentionally reads project files and common config files (package.json, pom.xml, requirements.txt, YAML/JSON/TOML/etc.), which can contain secrets or credentials in practice. While that access is coherent with analyzing a codebase, it is a privacy/secret-exposure risk when run against repositories containing sensitive data.
Persistence & Privilege
The skill does not request elevated platform privileges and 'always' is false. It does not modify other skills or system-wide settings. Autonomous invocation is allowed (platform default) but is not combined with other high-risk flags.
如何使用
- 确保已安装 OpenClaw（本地或 Docker 部署）
- 在对话框中输入安装命令：
/install project-docs-generator - 安装完成后，直接呼叫该 Skill 的名称或使用
/project-docs-generator触发 - 根据 Skill 的参数说明提供必要输入，即可获得结构化输出
版本历史
v1.0.0
project-docs-generator v1.0.0
- 首次发布，支持自动识别任意代码库并生成定制化文档体系。
- 适配多种项目类型（前端、后端、全栈、微服务、monorepo、SDK 等）。
- 智能分析项目结构、技术栈和模块划分，推荐最合适的文档结构与内容。
- 支持按需网络检索行业最佳实践，提升文档准确性与实用性。
- 提供 PlantUML 图表复杂度控制及校验工具，增强文档可读性。
- 内置项目分析、结构设计、内容生成、质量验证等完整流程和执行清单。
元数据
常见问题
project-docs-generator 是什么？
智能分析代码库并生成定制化文档系统。当用户需要：(1) 为新项目创建文档 (2) 补全现有项目文档 (3) 生成技术文档目录结构 (4) 创建架构设计文档 (5) 编写API文档或开发指南时触发此技能。支持任意技术栈和项目结构（纯前端、纯后端、全栈、微服务、monorepo、库/SDK等），自动识别项目特点并生成... 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件，目前累计下载 113 次。
如何安装 project-docs-generator？
在 OpenClaw 或 Claude Code 对话框中运行命令「/install project-docs-generator」即可一键安装，无需额外配置。
project-docs-generator 是免费的吗？
是的，project-docs-generator 完全免费，采用 MIT-0 许可证，可自由下载、安装和使用。
project-docs-generator 支持哪些平台？
project-docs-generator 跨平台运行，可在任意部署了 OpenClaw / Claude Code 的环境中使用（cross-platform）。
谁开发了 project-docs-generator？
由 LeoNardo-LB（@leonardo-lb）开发并维护，当前版本 v1.0.0。
推荐 Skills