AgentSkillsCN

docs_updater

自动更新项目文档,保持 .agent/docs/ 目录与项目实际状态同步。

中文原作
SKILL.md
--- frontmatter
name: docs_updater
description: 自动更新项目文档,保持 .agent/docs/ 目录与项目实际状态同步。

文档自动维护助手 (docs_updater)

此 Skill 用于确保项目文档(如 tech_stack.md)不会因为项目的演进而陈旧。

核心职责

  1. 依赖监控: 检查 package.json 的变更,同步更新库版本。
  2. 结构同步: 发现新目录或大文件移动时,更新目录结构树。
  3. 规则对齐: 确保文档不仅是事实的记录,也符合 rules.md 中的规范。

执行步骤

1. 定期体检 (Audit)

在进行重大功能开发或重构后,运行此检查:

  • 读取 package.json 并对比 .agent/docs/tech_stack.md 中的版本。
  • 扫描目录结构(list_dir)并对比文档中的描述。

2. 自动修正 (Sync)

  • 版本更新: 直接更新文档中的版本号。
  • 结构调整: 修正文档中的目录层级描述。
  • 补全信息: 发现新引入的核心库(如 axios, pinia 等)时,主动在文档中添加其定位。

3. 用户确认

生成的文档更新建议应告知用户:

反馈示例: "我注意到您升级了 vue 版本并新增了 src/services 目录。我已同步更新了 .agent/docs/tech_stack.md 以保持上下文准确。"

注意事项

  • 文档应保持简洁,不要记录细碎的内部逻辑,重点在于架构和技术选型。
  • 更新文档前,确保文件内容的可读性。