← 返回 Skills 市场
seanwyngaard

Technical Doc Generator

作者 Sean Wyngaard · GitHub ↗ · v1.0.0
cross-platform ⚠ suspicious
1133
总下载
0
收藏
3
当前安装
1
版本数
在 OpenClaw 中安装
/install technical-doc-generator
功能描述
Generate professional technical documentation from codebases — API docs, READMEs, architecture diagrams, changelogs, and onboarding guides. Use when writing docs, creating API documentation, or delivering documentation projects.
安全使用建议
This skill appears coherent and focused on scanning a codebase to produce docs. Before running it: (1) run it only on repositories you control or on a copied/sanitized snapshot — don't point it at / or your home directory; (2) avoid giving it repos that contain secrets or credentials (it may read .env.example or any file in the path); (3) if you want to limit risk, run in a sandboxed environment with no network access so it cannot fetch external resources; (4) verify generated outputs before publishing (it may infer authentication or configuration details that you should confirm). If you need absolute assurance, ask the skill author for explicit required binaries (e.g., git) and a more constrained instruction set.
功能分析
Type: OpenClaw Skill Name: technical-doc-generator Version: 1.0.0 The skill is classified as suspicious primarily due to the explicit inclusion of `Bash` in the `allowed-tools` list within `SKILL.md`. While the instructions themselves do not contain overtly malicious commands or prompt injection attempts, the ability to execute arbitrary shell commands (`Bash`) combined with broad file system access (reading codebases, config files like `.env.example`) presents a significant vulnerability. This capability could be exploited for remote code execution, data exfiltration, or other harmful actions if the agent's behavior is manipulated via prompt injection or if the skill were used by a malicious actor.
能力评估
Purpose & Capability
The name and description (generate README, API docs, architecture, changelog, onboarding) align with the SKILL.md instructions (scan repo files, detect frameworks, parse git history, generate docs). The allowed tools (Read, Write, Edit, Grep, Glob, Bash) are appropriate for repository scanning and document generation.
Instruction Scope
The instructions are focused on files typically found in a codebase (package.json, pyproject.toml, requirements.txt, go.mod, migrations, models, .env.example, LICENSE, git history). They do not instruct reading system config or external secrets. However, the runtime wording is open-ended ('scan the project', 'detect environment variables') and the skill is permitted to run Bash — so the agent could read any files under the provided path. Users should avoid passing overly broad paths (e.g., / or home) or repositories containing secrets.
Install Mechanism
There is no install spec and no code files; this is instruction-only. That minimizes disk writes and third-party downloads. The SKILL.md implies use of repo-local commands (git, parsing package files) but does not require external installers.
Credentials
The skill declares no required environment variables, credentials, or config paths. The documented behavior (detecting env var names used in the code, reading .env.example) is consistent with documentation generation and does not require access to secrets or external credentials.
Persistence & Privilege
The skill is not always-enabled and does not request persistent privileges or modification of other skills. Autonomous invocation is permitted by default but not excessive here; nothing in the manifest indicates it will persist or escalate privileges.
如何使用
  1. 确保已安装 OpenClaw(本地或 Docker 部署)
  2. 在对话框中输入安装命令:/install technical-doc-generator
  3. 安装完成后,直接呼叫该 Skill 的名称或使用 /technical-doc-generator 触发
  4. 根据 Skill 的参数说明提供必要输入,即可获得结构化输出
版本历史
v1.0.0
Initial release of technical-doc-generator: generate complete technical documentation from codebases. - Supports automated creation of API docs, READMEs, architecture overviews, changelogs, and onboarding guides. - Detects project structure, frameworks, and technologies using codebase scanning. - Outputs documentation files in Markdown, OpenAPI YAML, and Mermaid diagrams. - Organizes generated docs in an output directory for easy client delivery. - Offers both targeted (single doc-type) and full-package documentation generation options.
元数据
Slug technical-doc-generator
版本 1.0.0
许可证
累计安装 3
当前安装数 3
历史版本数 1
常见问题

Technical Doc Generator 是什么?

Generate professional technical documentation from codebases — API docs, READMEs, architecture diagrams, changelogs, and onboarding guides. Use when writing docs, creating API documentation, or delivering documentation projects. 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件,目前累计下载 1133 次。

如何安装 Technical Doc Generator?

在 OpenClaw 或 Claude Code 对话框中运行命令「/install technical-doc-generator」即可一键安装,无需额外配置。

Technical Doc Generator 是免费的吗?

是的,Technical Doc Generator 完全免费(开源免费),可自由下载、安装和使用。

Technical Doc Generator 支持哪些平台?

Technical Doc Generator 跨平台运行,可在任意部署了 OpenClaw / Claude Code 的环境中使用(cross-platform)。

谁开发了 Technical Doc Generator?

由 Sean Wyngaard(@seanwyngaard)开发并维护,当前版本 v1.0.0。

💬 留言讨论