Generate project documentation
v1.0.0分析当前项目代码库，自动生成全面的技术文档（项目概览、架构设计、模块说明、API 文档、数据模型、依赖关系、部署说明），输出到 docs/ 目录。通过 subagent 并行分析，适用于任意规模的项目。
⭐ 0· 35·0 current·0 all-time
by@hhngdcz
MIT-0
Download zip
LicenseMIT-0 · Free to use, modify, and redistribute. No attribution required.
Security Scan
OpenClaw
Benign
medium confidencePurpose & Capability
Name/description match what the SKILL.md and prompt templates do: scan repository structure, read project metadata and source (via subagents), and write docs/*.md. No unrelated credentials, binaries, or install steps are requested.
Instruction Scope
Instructions carefully separate roles: main agent does top-level scanning (glob only) and coordination, subagents read source/config files and write docs. The skill explicitly excludes sensitive paths (e.g., .env) and promises subagents only return one-line summaries. Two small points to note: (1) some subagent prompts instruct running a Bash mkdir command (mkdir -p docs/modules) — this is a filesystem write operation rather than pure prompt work and assumes the runtime allows shell operations; (2) the safety of 'never return document content' depends on the platform enforcing that constraint for subagents. Both are operational considerations rather than conceptual mismatches.
Install Mechanism
Instruction-only skill with no install spec and no code files to be written by an installer. Lowest install risk.
Credentials
No environment variables, credentials, or config paths are requested. Files read (package.json, pyproject.toml, Dockerfile, source files, README) are appropriate and necessary for documentation generation.
Persistence & Privilege
always:false and user-invocable:true. The skill writes into docs/ but does not request persistent elevated privileges or modify other skills' configs.
Assessment
This skill appears coherent and appropriate for auto-generating project docs: it will scan repo structure, read project metadata and source (via subagents), and write files under docs/. Before running it: (1) back up your existing docs/ if you care about current content—the skill will offer an overwrite/append/ cancel choice but still writes files; (2) confirm your agent runtime enforces the guardrails claimed (that subagents only return a one-line summary and that .env/.venv are excluded); (3) ensure you trust the execution environment to handle the stated Bash/write operations (some platforms may not support arbitrary shell commands or may elevate risk if they do); (4) review the generated docs for accuracy — the skill states it will not fabricate behaviour, but automated summarization can still misinterpret code. If any of these platform guarantees (enforced summary-only returns, exclusion of sensitive files, safe file-write APIs) are absent, consider running the skill on a copy of the repo first.Like a lobster shell, security has layers — review code before you run it.
latestvk979bxy4g7djc6rzpmsckpatt5842eeg
License
MIT-0
Free to use, modify, and redistribute. No attribution required.