← Back to Skills Marketplace
aiweline

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

by Aiweline · GitHub ↗ · v1.0.0 · MIT-0
cross-platform ✓ Security Clean
39
Downloads
0
Stars
0
Active Installs
1
Versions
Install in OpenClaw
/install docs-change-records
Description
Documentation engineer skill for module docs, README updates, architecture notes, API change records, and repository-safe documentation placement.
README (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\r
  • AI-README.md\r
  • CLAUDE.md\r
  • dev/ai/skills/documentation-standards/SKILL.md\r
  • dev/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

  1. Identify whether the change affects usage, architecture, interfaces, or only internal code.\r
  2. Locate the owning module doc directory, README, architecture note, or API documentation path.\r
  3. Update only the documents required by the actual change.\r
  4. Keep the documentation outcome-focused rather than writing long process diaries.\r
  5. Cross-check claims against the final implementation and validation evidence.\r
  6. Confirm any bug-fix status note is reflected in the module README where required.\r
  7. 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
Usage Guidance
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.
Capability Analysis
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'.
Capability Assessment
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.
How to Use
  1. Make sure OpenClaw is installed (local or Docker)
  2. Run the install command in chat: /install docs-change-records
  3. After installation, invoke the skill by name or use /docs-change-records
  4. Provide required inputs per the skill's parameter spec and get structured output
Version History
v1.0.0
Publish_WelineFramework_Multica_role_skills
Metadata
Slug docs-change-records
Version 1.0.0
License MIT-0
All-time Installs 0
Active Installs 0
Total Versions 1
Frequently Asked Questions

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

Documentation engineer skill for module docs, README updates, architecture notes, API change records, and repository-safe documentation placement. It is an AI Agent Skill for Claude Code / OpenClaw, with 39 downloads so far.

How do I install 文档知识库工程师 文档规范与变更记录?

Run "/install docs-change-records" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.

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

Yes, 文档知识库工程师 文档规范与变更记录 is completely free, licensed under MIT-0. You can download, install and use it at no cost.

Which platforms does 文档知识库工程师 文档规范与变更记录 support?

文档知识库工程师 文档规范与变更记录 is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).

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

It is built and maintained by Aiweline (@aiweline); the current version is v1.0.0.

💬 Comments