mingyuepop/specforge/project-doc-updater
Claude Code and agent skill by mingyuepop/specforge
Trust tier 2
- community
Source check pending
Checking that the SKILL.md file is still in the repository.
更新项目文档以匹配代码库的实际情况。当实现与文档产生偏差,或用户要求同步/更新文档时调用。
Install
npx vskill@latest install mingyuepop/specforge/project-doc-updaterSKILL.md
项目文档更新器 (Project Documentation Updater)
角色
你是 文档守护者 (Documentation Guardian)。你的目标是确保项目文档(特别是 .trae/rules/ 和 .ai-specs/ 目录下的文档)准确反映代码库的当前状态。
何时使用
- 当用户明确要求“更新文档”或“同步文档”时。
- 当你检测到代码实现(例如:技术栈、文件夹结构)与文档规范发生了偏差时。
- 在完成重大功能实现后,如果该功能改变了项目结构或引入了新技术。
边界守卫 (Guardrails) - CRITICAL
请严格遵守通用边界守卫规则:specs/GUARDRAILS.md 当前阶段: 规划与管理阶段 (Planning & Management)
工作流程
- 分析上下文 (Analyze Context):
- 阅读当前代码库,理解实际状态(技术栈、项目结构、关键功能)。
- 阅读现有的文档文件:
-
specs/1_产品概述.md(产品概述) -
specs/2_技术栈.md(技术栈) -
specs/3_项目结构.md(项目结构) -
specs/*.md(任何生效的规则)
- 识别偏差 (Identify Deviations):
- 对比实际代码与文档规范。
- 列出具体的差异点(例如:“文档说是 MySQL,但代码里用了 PostgreSQL”)。
- 更新文档 (Update Documentation):
- 动作:修改文档文件以匹配代码。代码是唯一的事实来源 (The Code is the Source of Truth)。
- 风格:保持文档现有的格式和语气。
- 验证:确保更新后的文档之间保持一致。
- 报告 (Report):
- 告知用户你更新了什么以及为什么更新。
- 示例:“我注意到您使用了
pnpm而不是npm,所以我更新了2_技术栈.md以反映这一变化。”
安全事项
- 不要删除整段内容,除非它们明显已经过时。
- 如果偏差模棱两可(例如:遗留代码 vs 新文档),在覆盖前先询问用户。
Security
- Security scanPassed, 100 of 100Pattern checks on the skill's files.
- Model reviewNot runA model review is scheduled for the next rescan.
Quality evaluation
- Task evaluationNot runNo evaluation yet. Run one in Skill Studio.
Source
- SKILL.md in the repositoryCheckingV1/skills/project-doc-updater/SKILL.md
Popularity
- 7-day trend score
- 0
Not refreshed yet.
Works with
Any agent vskill installs to: 56 targets in all. These 39 have a page on this site.
- Claude Code
- Cursor
- GitHub Copilot
- Windsurf
- Codex
- Gemini CLI
- Cline
- Amp
- Roo Code
- Goose
- Continue
- Kilo Code
- Junie
- Trae
- OpenHands
- Qwen Code
- AI Agent
- Tabnine Chat
- Sourcegraph Cody
- Amazon Q
- Firebase Genkit
- Sweep
- Devin
- Phind
- Mentat
- Claude Desktop
- Aider
- GPT Pilot
- Plandex
- bolt.new
- v0
- Replit Agent
- Anse
- TypingMind
- BetterChatGPT
- LibreChat
- Warp AI
- Pieces
- Fig AI
Embed badge
[](https://verified-skill.com/skills/mingyuepop/specforge/project-doc-updater)