← 返回 Skills 市场
Update Docs on Code Change
作者
John Haugabook
· GitHub ↗
· v1.0.0
· MIT-0
116
总下载
0
收藏
0
当前安装
1
版本数
在 OpenClaw 中安装
/install update-docs-on-code-change
功能描述
Automatically update README.md and documentation files when application code changes require documentation updates. Use when adding new features, changing AP...
安全使用建议
This skill is instruction-only and internally consistent with its purpose, but it is intentionally high-level and will rely on whatever repository and tooling access the agent already has. Before enabling it: (1) review and limit the agent's repository and CI permissions to least privilege (read vs write, ability to push/commit), (2) confirm whether the agent is allowed to execute build/tests in your environment (these steps can run arbitrary code), (3) require human review or PR workflow for doc commits if you don't want automated pushes, and (4) monitor for unexpected network or credential access because the skill's prose could lead an agent to call external services depending on implementation. If you want stricter behavior, require the skill to only produce suggested edits as PR comments rather than making commits automatically.
功能分析
Type: OpenClaw Skill
Name: update-docs-on-code-change
Version: 1.0.0
The skill bundle contains only documentation and instructions (SKILL.md) for an AI agent to maintain project documentation (README, API docs, changelogs) in response to code changes. There is no executable code, no network activity, no data exfiltration, and no evidence of prompt injection or malicious intent.
能力评估
Purpose & Capability
Name and description (update docs on code change) match the content of SKILL.md. The skill does not request unrelated binaries, credentials, or config paths — everything requested (none) is proportional to the stated purpose.
Instruction Scope
SKILL.md contains broad, high-level procedures for when/how to update README, API docs, changelogs, and migration guides. It does not include explicit commands, external endpoints, or requests for secrets, but it is intentionally open-ended (e.g., 'verify examples still compile/run', 'access to code changes') which grants implementation discretion to the agent. That vagueness could lead an agent to run build/test commands or modify repository files if given repository access — expected for the purpose but worth reviewing in deployment.
Install Mechanism
No install spec and no code files. This is the lowest-risk pattern: the skill only provides prose instructions and nothing is written to disk by the skill itself.
Credentials
The skill declares no required environment variables, credentials, or config paths. SKILL.md references repository files (README.md, docs/) which is appropriate. There are no unexpected requests for secrets or unrelated service tokens.
Persistence & Privilege
always is false and the skill does not request persistent system-wide modifications. It does not claim to modify other skills or agent-wide settings. Autonomous invocation is allowed (platform default) but is not combined with elevated privileges.
如何使用
- 确保已安装 OpenClaw（本地或 Docker 部署）
- 在对话框中输入安装命令：
/install update-docs-on-code-change - 安装完成后，直接呼叫该 Skill 的名称或使用
/update-docs-on-code-change触发 - 根据 Skill 的参数说明提供必要输入，即可获得结构化输出
版本历史
v1.0.0
- Initial release of update-docs-on-code-change skill.
- Automatically detects when documentation files (e.g., README.md, API docs, changelog, migration guides) need updates based on specific code changes.
- Provides detailed guidance and best practices for updating documentation in response to code modifications.
- Includes review checklists, update workflows, documentation quality standards, and validation commands to maintain synchronized and high-quality docs.
元数据
常见问题
Update Docs on Code Change 是什么？
Automatically update README.md and documentation files when application code changes require documentation updates. Use when adding new features, changing AP... 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件，目前累计下载 116 次。
如何安装 Update Docs on Code Change？
在 OpenClaw 或 Claude Code 对话框中运行命令「/install update-docs-on-code-change」即可一键安装，无需额外配置。
Update Docs on Code Change 是免费的吗？
是的，Update Docs on Code Change 完全免费，采用 MIT-0 许可证，可自由下载、安装和使用。
Update Docs on Code Change 支持哪些平台？
Update Docs on Code Change 跨平台运行，可在任意部署了 OpenClaw / Claude Code 的环境中使用（cross-platform）。
谁开发了 Update Docs on Code Change？
由 John Haugabook（@jhauga）开发并维护，当前版本 v1.0.0。
推荐 Skills