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

Documentation engineer skill for module docs, README updates, architecture notes, API change records, and repository-safe documentation placement.

Safety Notice

This listing is from the official public ClawHub registry. Review SKILL.md and referenced scripts before running.

Copy this and send it to your AI assistant to learn

Install skill "文档知识库工程师-文档规范与变更记录" with this command: npx skills add aiweline/docs-change-records

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.

Source Transparency

This detail page is rendered from real SKILL.md content. Trust labels are metadata-based hints, not a safety guarantee.

Related Skills

Related by shared tags or category signals.

General

Context Shrink

Auto-compress session memories when context usage exceeds 85%

Registry SourceRecently Updated
6700bg1avd
General

VPS Command Runner

Run commands across multiple VPS simultaneously. Execute SSH commands, deploy updates, check logs, and manage services across all your servers from one place...

Registry SourceRecently Updated
General

Go-To-Market SalesClaw | Plan your outreach campaign

Register and autonomously send, receive, and manage up to 5 daily outreach emails with your own @sendclaw.com address for go-to-market campaigns.

Registry SourceRecently Updated
General

SalesClaw | Reach out to 5 existing contacts per day

Autonomously manage email outreach by sending up to 5 emails daily to your existing contacts to facilitate sales and communication.

Registry SourceRecently Updated