← 返回 Skills 市场
update-project-docs
作者
Ge Haizhou
· GitHub ↗
· v1.0.3
· MIT-0
168
总下载
0
收藏
0
当前安装
4
版本数
在 OpenClaw 中安装
/install update-project-docs
功能描述
This skill should be used when the user asks to "update documentation for my changes", "check docs for this PR", "what docs need updating", "sync docs with c...
安全使用建议
This skill appears to do what it says: it will read your repository, run git queries, search docs, run project doc build/lint commands if available, write a .docs-sync tracking file, and stage/commit documentation changes. Before installing or running it, consider: (1) review the SKILL.md so you’re comfortable with the skill reading the whole repo and creating commits; (2) be aware that running project doc build scripts (npm/make/sphinx/etc.) can execute arbitrary project-defined code — run in an isolated environment if the repo is untrusted; (3) ensure you want an automated tool to write a .docs-sync file and create commits, and confirm commit/branch policies; (4) the skill requests no external credentials, but double-check any prompts the agent makes before it stages/commits changes. If you need stricter control, require manual confirmation for every commit or run the skill in a throwaway clone/CI job first.
功能分析
Type: OpenClaw Skill
Name: update-project-docs
Version: 1.0.3
The 'update-project-docs' skill bundle is a comprehensive and well-structured tool designed to help an AI agent maintain project documentation. It includes detailed workflows for auditing codebases, performing incremental updates based on git diffs, and scaffolding documentation infrastructure (e.g., Docsify). The instructions in SKILL.md and the reference files (CODE-TO-DOCS-MAPPING.md, DOC-CONVENTIONS.md) emphasize discovery, consistency with existing project styles, and explicit user confirmation before any file modifications or deletions. No indicators of malicious intent, data exfiltration, or harmful prompt injection were found; the skill's capabilities are entirely aligned with its stated purpose of documentation management.
能力评估
Purpose & Capability
The name/description match the runtime instructions: the skill inspects the repository, finds documentation, maps code to docs, scaffolds missing docs, runs validation, records a sync-point, and commits doc changes. It does not request unrelated credentials, binaries, or external installs.
Instruction Scope
Instructions require reading the entire codebase and documentation, running git commands, and optionally running the project's documentation build/lint commands (e.g., npm run docs:dev, mkdocs, sphinx). This is expected for the task but means the skill may execute project-defined build scripts which can run arbitrary code; the skill documents prompting the user before proceeding on uncommitted changes and requests explicit confirmation for commit actions.
Install Mechanism
Instruction-only skill with no install spec and no code files — nothing is downloaded or installed by the skill itself, which minimizes installation risk.
Credentials
The skill declares no required environment variables, credentials, or config paths. It relies on repository access and local tooling (git, project build tools), which is proportional to its stated purpose.
Persistence & Privilege
The skill writes a repository-tracked sync file (e.g., .docs-sync) and stages/commits documentation changes. This is appropriate for an updater but means it modifies repository state — the user should ensure they want the skill to create commits and write tracking files.
如何使用
- 确保已安装 OpenClaw(本地或 Docker 部署)
- 在对话框中输入安装命令:
/install update-project-docs - 安装完成后,直接呼叫该 Skill 的名称或使用
/update-project-docs触发 - 根据 Skill 的参数说明提供必要输入,即可获得结构化输出
版本历史
v1.0.3
Version 1.0.3
- No changes detected in code or documentation files.
- No updates to features, workflows, or usage instructions.
v1.0.2
update-project-docs 1.0.2
- Improved incremental update logic: now resolves the "effective diff base" to avoid reprocessing the previous documentation-sync commit on each run.
- Sync record now explicitly refers to the code state that docs are synced to, and guidance is clearer on recording and using this commit hash.
- Incremental run now intelligently skips commits that only update the sync record, streamlining the review process.
- Commit staging instructions clarify that both documentation changes and the updated sync record should be staged together.
v1.0.1
**Summary: First-run full-project audit mode added; run behavior is now more robust and accurate.**
- Added a dedicated first-run workflow: on initial use (no sync record), performs a full-project documentation audit instead of relying on recent code diffs.
- Always determines run mode: first run triggers a full audit; later runs switch to incremental diff-based updates from the last recorded sync point.
- Documents the importance of using the most capable model and maximum effort for the initial audit, as subsequent incremental runs rely on this baseline.
- Added explicit handling for sidebar/navigation config files—documentation structure is now correctly mapped to sidebar hierarchy where available.
- Clarifies fallback behavior: if the sync record's commit is missing, warns user and reverts to full-audit mode.
- Existing incremental update flow is unchanged, but now built atop a more reliable "first-run sets the base" foundation.
v1.0.0
Initial release of update-project-docs, providing a guided workflow to help update project documentation based on code changes.
- Guides users through pre-flight checks, project structure discovery, and identification of documentation impact from code changes.
- Analyzes diffs since last sync or base branch to determine which documentation files require updating.
- Maps code changes to affected documentation, prompting user review and confirmation.
- Validates documentation updates using project-specific lint/build commands where available.
- Records a sync point to enable incremental documentation updates in future runs.
- Supports diverse project structures, programming languages, and documentation formats.
元数据
常见问题
update-project-docs 是什么?
This skill should be used when the user asks to "update documentation for my changes", "check docs for this PR", "what docs need updating", "sync docs with c... 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件,目前累计下载 168 次。
如何安装 update-project-docs?
在 OpenClaw 或 Claude Code 对话框中运行命令「/install update-project-docs」即可一键安装,无需额外配置。
update-project-docs 是免费的吗?
是的,update-project-docs 完全免费,采用 MIT-0 许可证,可自由下载、安装和使用。
update-project-docs 支持哪些平台?
update-project-docs 跨平台运行,可在任意部署了 OpenClaw / Claude Code 的环境中使用(cross-platform)。
谁开发了 update-project-docs?
由 Ge Haizhou(@openghz)开发并维护,当前版本 v1.0.3。
推荐 Skills