AgentSkillsCN

update-docs

在创建 PR 之前,对构建、类型检查、代码风格检查、测试及安全检查进行全面验证。

SKILL.md
--- frontmatter
name: update-docs
description: Sync documentation from source-of-truth files
user-invocable: true
disable-model-invocation: true

Update Documentation

Sync documentation from source-of-truth:

  1. Read package.json scripts section

    • Generate scripts reference table
    • Include descriptions from comments
  2. Read .env.example

    • Extract all environment variables
    • Document purpose and format
  3. Generate docs/CONTRIB.md with:

    • Development workflow
    • Available scripts
    • Environment setup
    • Testing procedures
  4. Generate docs/RUNBOOK.md with:

    • Deployment procedures
    • Monitoring and alerts
    • Common issues and fixes
    • Rollback procedures
  5. Identify obsolete documentation:

    • Find docs not modified in 90+ days
    • List for manual review
  6. Show diff summary

Single source of truth: package.json and .env.example