← 返回 Skills 市场
39
总下载
0
收藏
0
当前安装
1
版本数
在 OpenClaw 中安装
/install docs-change-records
功能描述
Documentation engineer skill for module docs, README updates, architecture notes, API change records, and repository-safe documentation placement.
使用说明 (SKILL.md)
\r \r
Role\r
\r This skill owns documentation updates that must accompany code changes. It keeps module README files, architecture notes, API descriptions, and change records accurate without dumping detailed fix logs into the repository root.\r \r
When To Use\r
\r
- Use for module README updates, architecture docs, API docs, usage docs, and change records.\r
- Use for keywords such as documentation, README, architecture doc, API doc, fix note, and change record.\r
- Use when a code change alters user behavior, module usage, architecture, or interfaces.\r \r
Source Material\r
\r
AI-ENTRY.md\rAI-README.md\rCLAUDE.md\rdev/ai/skills/documentation-standards/SKILL.md\rdev/ai/skills/weline-framework-core/SKILL.md\r \r
Responsibilities\r
\r
- Update the right documentation at the right scope.\r
- Keep fix notes in related module doc directories instead of the repository root.\r
- Reflect design and interface changes accurately and concisely.\r
- Preserve the distinction between user-facing docs, architecture docs, and API docs.\r \r
Workflow\r
\r
- Identify whether the change affects usage, architecture, interfaces, or only internal code.\r
- Locate the owning module doc directory, README, architecture note, or API documentation path.\r
- Update only the documents required by the actual change.\r
- Keep the documentation outcome-focused rather than writing long process diaries.\r
- Cross-check claims against the final implementation and validation evidence.\r
- Confirm any bug-fix status note is reflected in the module README where required.\r
- Report what was updated and why.\r \r
Weline Rules\r
\r
- Do not write detailed fix reports to the repository root.\r
- Write fix reports inside the related module doc directory.\r
- Update module README after fixing bugs.\r
- Update architecture docs if the design changes.\r
- Update API docs if interfaces change.\r \r
Inputs Required\r
\r
- The implemented change and its user, architecture, or interface impact.\r
- The owning module and documentation paths.\r
- Validation evidence that supports the documentation update.\r
- Any required wording scope, such as developer-facing or user-facing.\r \r
Expected Output\r
\r
- Updated documentation in the correct repository location.\r
- A concise record of behavior, design, or interface changes.\r
- Documentation aligned with the implemented and validated result.\r \r
Validation\r
\r
- Check that documentation location matches the owning module or architecture scope.\r
- Check that README, architecture, and API updates were made when required.\r
- Check that documentation does not promise behavior not proven by implementation.\r
- Check that no detailed fix report was written into the repository root.\r \r
Constraints\r
\r
- Do not create unnecessary documents when no user or interface impact exists.\r
- Do not dump step-by-step troubleshooting logs into repository docs.\r
- Do not update root-level files when the correct location is module-local documentation.\r
- Do not leave changed interfaces undocumented.\r \r
安全使用建议
This skill appears safe for documentation maintenance. Before accepting its output, review the repository diff to ensure it only updates the intended documentation files and does not add unsupported claims.
功能分析
Type: OpenClaw Skill
Name: docs-change-records
Version: 1.0.0
The skill bundle is a documentation management tool designed to automate updates to README files, API documentation, and change records. Analysis of SKILL.md and _meta.json reveals no executable code, network activity, or instructions for data exfiltration; the logic is strictly limited to organizing and maintaining project documentation according to specified 'Weline Rules'.
能力评估
Purpose & Capability
The stated purpose is maintaining README, architecture, API, and change-record documentation, and the workflow stays within that documentation scope.
Instruction Scope
The instructions explicitly limit updates to required documents and discourage unnecessary or root-level fix reports.
Install Mechanism
There is no install spec, no code files, no required binaries, and no required environment variables.
Credentials
The skill is intended to update repository documentation, which is expected for this purpose but should still be reviewed through normal version-control diffs.
Persistence & Privilege
The artifacts do not request credentials, privileged paths, persistent background behavior, memory storage, or account access.
如何使用
- 确保已安装 OpenClaw(本地或 Docker 部署)
- 在对话框中输入安装命令:
/install docs-change-records - 安装完成后,直接呼叫该 Skill 的名称或使用
/docs-change-records触发 - 根据 Skill 的参数说明提供必要输入,即可获得结构化输出
版本历史
v1.0.0
Publish_WelineFramework_Multica_role_skills
元数据
常见问题
文档知识库工程师 文档规范与变更记录 是什么?
Documentation engineer skill for module docs, README updates, architecture notes, API change records, and repository-safe documentation placement. 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件,目前累计下载 39 次。
如何安装 文档知识库工程师 文档规范与变更记录?
在 OpenClaw 或 Claude Code 对话框中运行命令「/install docs-change-records」即可一键安装,无需额外配置。
文档知识库工程师 文档规范与变更记录 是免费的吗?
是的,文档知识库工程师 文档规范与变更记录 完全免费,采用 MIT-0 许可证,可自由下载、安装和使用。
文档知识库工程师 文档规范与变更记录 支持哪些平台?
文档知识库工程师 文档规范与变更记录 跨平台运行,可在任意部署了 OpenClaw / Claude Code 的环境中使用(cross-platform)。
谁开发了 文档知识库工程师 文档规范与变更记录?
由 Aiweline(@aiweline)开发并维护,当前版本 v1.0.0。
推荐 Skills