AgentSkillsCN

update-documentation

根据近期的代码变更,触发文档更新。当用户说“更新文档”或“为 [范围] 编写文档”时使用。系统会评估变更内容,更新 README、功能文档与架构文档,并验证文档构建是否成功。

SKILL.md
--- frontmatter
name: update-documentation
description: >
  Trigger documentation updates based on recent code changes.
  Use when user says "update documentation" or "document [scope]".
  Assesses changes, updates README/feature docs/architecture docs, and verifies documentation builds.

Update Documentation

Trigger documentation updates based on recent code changes.

Usage: When user says "update documentation" or "document [scope]"

Instructions

  1. Assess Changes:

    • Identify recent code changes (commits, modified files).
    • Determine impact on existing documentation (API references, feature guides, architecture docs).
  2. Update Documentation:

    • Use the Documentation Agent for comprehensive updates.
    • Update README.md if high-level features changed.
    • Update specific feature docs in docs/.
    • Update architecture diagrams or descriptions if designs changed.
  3. Verify:

    • Ensure the documentation site (if applicable) builds.
    • Verify links and references are valid.
    • Ensure consistent style and tone.

Scopes

  • feature: Focus on a specific feature folder.
  • api: Focus on API reference updates.
  • global: Review and update project-level docs (README, Architecture).