文档知识库工程师 文档规范与变更记录

SKILL效率
效率 未标注权限 许可证不明确
安装这个技能

文档工程师技能:模块文档、README 更新、架构说明、API 变更记录及仓库安全文档放置。

累计安装 未标注 本周 未标注
GitHub 星标 未标注 仓库 未标注
下载量 未标注 技能市场下载数
权限级别 未标注权限 安装前请确认风险范围
许可证 许可证不明确 未说明

安装

ClawHub 市场
在支持 Skills 的客户端里执行,装完问一句「你有哪些技能」验证
skillhub install clawhub_aiweline/docs-change-records

技能档案

效率
字段来自技能仓库与公开索引,中文说明由本站标注
作者 / 维护方clawhub_aiweline仓库 未标注 · 版本 未标注
宿主客户端未标注技能可被这些客户端加载
安装方式ClawHub 市场安装包 clawhub
权限级别未标注权限安装前请确认风险范围
许可证未说明许可证不明确,商用前请自行确认条款
仓库可用性available技能仓库当前是否可访问
最近核验未标注上游最后核验时间 · 数据更新 1791726666
正文体量3.8 KBSKILL.md 原文大小,越大说明说明书写得越细

SKILL.md 全文

3.8 KB
模型实际读到的说明书原文,来自技能仓库

Role

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.

When To Use

  • Use for module README updates, architecture docs, API docs, usage docs, and change records.
  • Use for keywords such as documentation, README, architecture doc, API doc, fix note, and change record.
  • Use when a code change alters user behavior, module usage, architecture, or interfaces.

Source Material

  • AI-ENTRY.md
  • AI-README.md
  • CLAUDE.md
  • dev/ai/skills/documentation-standards/SKILL.md
  • dev/ai/skills/weline-framework-core/SKILL.md

Responsibilities

  • Update the right documentation at the right scope.
  • Keep fix notes in related module doc directories instead of the repository root.
  • Reflect design and interface changes accurately and concisely.
  • Preserve the distinction between user-facing docs, architecture docs, and API docs.

Workflow

  1. Identify whether the change affects usage, architecture, interfaces, or only internal code.
  2. Locate the owning module doc directory, README, architecture note, or API documentation path.
  3. Update only the documents required by the actual change.
  4. Keep the documentation outcome-focused rather than writing long process diaries.
  5. Cross-check claims against the final implementation and validation evidence.
  6. Confirm any bug-fix status note is reflected in the module README where required.
  7. Report what was updated and why.

Weline Rules

  • Do not write detailed fix reports to the repository root.
  • Write fix reports inside the related module doc directory.
  • Update module README after fixing bugs.
  • Update architecture docs if the design changes.
  • Update API docs if interfaces change.

Inputs Required

  • The implemented change and its user, architecture, or interface impact.
  • The owning module and documentation paths.
  • Validation evidence that supports the documentation update.
  • Any required wording scope, such as developer-facing or user-facing.

Expected Output

  • Updated documentation in the correct repository location.
  • A concise record of behavior, design, or interface changes.
  • Documentation aligned with the implemented and validated result.

Validation

  • Check that documentation location matches the owning module or architecture scope.
  • Check that README, architecture, and API updates were made when required.
  • Check that documentation does not promise behavior not proven by implementation.
  • Check that no detailed fix report was written into the repository root.

Constraints

  • Do not create unnecessary documents when no user or interface impact exists.
  • Do not dump step-by-step troubleshooting logs into repository docs.
  • Do not update root-level files when the correct location is module-local documentation.
  • Do not leave changed interfaces undocumented.

Shared Collaboration Contract

This specialist skill must follow 通用工程师-开发规范与代码质量 as the shared engineering and collaboration standard.

Before and during work:

  • Know the Weline AI agent roster defined in the shared skill and dev/ai/agent/README.md.
  • Keep work inside this specialist's ownership boundary.
  • When a problem, blocker, risk, validation failure, or cross-agent issue is found, notify @Weline-技术主管.
  • Do not silently expand scope to fix another agent's area.
  • Include collaboration status in the final report.

热门专题

按场景挑技能
全部专题 →

技能内容以作者仓库为准;分类、权限级别与许可证状态的中文说明为中文整理,最近核验 未标注。