← 返回 Skills 市场
engsathiago

Documentation Writer

作者 engsathiago · GitHub ↗ · v1.0.0 · MIT-0
cross-platform ✓ 安全检测通过
537
总下载
0
收藏
3
当前安装
1
版本数
在 OpenClaw 中安装
/install documentation-writer
功能描述
Write clear, comprehensive documentation. Covers README files, API docs, user guides, and code comments. Create documentation that users actually read and un...
使用说明 (SKILL.md)

k978xwzwpfct5c9grdtfzqvhnn8309ze

安全使用建议
This skill is coherent and low-risk: it provides templates and advice only. Before using, avoid pasting real credentials or sensitive files into prompts (examples show placeholders). Note the skill has no homepage and source is listed as unknown — if provenance matters for your environment prefer skills from known publishers or review the SKILL.md content yourself. Autonomous invocation is enabled by default (normal); if you do not want the agent to call the skill without your explicit prompting, disable autonomous skills in your agent settings.
功能分析
Type: OpenClaw Skill Name: documentation-writer Version: 1.0.0 The documentation-writer skill bundle is a collection of templates, best practices, and instructional guidelines designed to help an AI agent generate high-quality technical documentation. The content in SKILL.md consists entirely of Markdown structures, code examples (Python, JavaScript, Bash), and writing tips for READMEs and API docs, with no evidence of malicious intent, data exfiltration, or prompt injection attacks.
能力评估
Purpose & Capability
Name/description (documentation writer: READMEs, API docs, guides, comments) align with the content of SKILL.md which contains templates, patterns, and examples. There are no unrelated binaries, environment variables, or config paths declared.
Instruction Scope
SKILL.md contains static templates, writing guidance, and code/documentation examples. It does not instruct the agent to run shell commands, read system files, access environment variables, or transmit data to external endpoints. Example snippets include placeholder API key strings but are demonstrative only.
Install Mechanism
No install spec and no code files — the skill is instruction-only, so nothing is downloaded or written to disk by an installer.
Credentials
The skill declares no required environment variables or credentials. Although example code shows placeholder api_key values, the skill neither requests nor needs real secrets to perform its stated task.
Persistence & Privilege
always:false and user-invocable:true (normal). The skill does not request persistent system presence or modify other skills/configs.
如何使用
  1. 确保已安装 OpenClaw(本地或 Docker 部署)
  2. 在对话框中输入安装命令:/install documentation-writer
  3. 安装完成后,直接呼叫该 Skill 的名称或使用 /documentation-writer 触发
  4. 根据 Skill 的参数说明提供必要输入,即可获得结构化输出
版本历史
v1.0.0
Initial release
元数据
Slug documentation-writer
版本 1.0.0
许可证 MIT-0
累计安装 3
当前安装数 3
历史版本数 1
常见问题

Documentation Writer 是什么?

Write clear, comprehensive documentation. Covers README files, API docs, user guides, and code comments. Create documentation that users actually read and un... 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件,目前累计下载 537 次。

如何安装 Documentation Writer?

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

Documentation Writer 是免费的吗?

是的,Documentation Writer 完全免费,采用 MIT-0 许可证,可自由下载、安装和使用。

Documentation Writer 支持哪些平台?

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

谁开发了 Documentation Writer?

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

💬 留言讨论