← Back to Skills Marketplace
Update Docs on Code Change
by
John Haugabook
· GitHub ↗
· v1.0.0
· MIT-0
116
Downloads
0
Stars
0
Active Installs
1
Versions
Install in OpenClaw
/install update-docs-on-code-change
Description
Automatically update README.md and documentation files when application code changes require documentation updates. Use when adding new features, changing AP...
Usage Guidance
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.
Capability Analysis
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.
Capability Assessment
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.
How to Use
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install update-docs-on-code-change - After installation, invoke the skill by name or use
/update-docs-on-code-change - Provide required inputs per the skill's parameter spec and get structured output
Version History
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.
Metadata
Frequently Asked Questions
What is 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... It is an AI Agent Skill for Claude Code / OpenClaw, with 116 downloads so far.
How do I install Update Docs on Code Change?
Run "/install update-docs-on-code-change" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is Update Docs on Code Change free?
Yes, Update Docs on Code Change is completely free, licensed under MIT-0. You can download, install and use it at no cost.
Which platforms does Update Docs on Code Change support?
Update Docs on Code Change is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created Update Docs on Code Change?
It is built and maintained by John Haugabook (@jhauga); the current version is v1.0.0.
More Skills