一键导入
project-sync-docs
根据本次工作内容,同步更新项目文档,保持文档与代码实现一致。当用户说"更新文档"、"同步文档"、"文档过时了"、"更新 CLAUDE.md"、"更新 AGENTS.md"、"更新 README"或输入 /sync-docs 时触发。完成功能开发、bug 修复、架构调整后也应主动提示使用。
用 Codex 或 Claude 帮你安装 复制这段 Prompt,粘贴到 Codex、Claude 或其他助手里,让它检查 Skill 页面并帮你完成安装。
菜单
根据本次工作内容,同步更新项目文档,保持文档与代码实现一致。当用户说"更新文档"、"同步文档"、"文档过时了"、"更新 CLAUDE.md"、"更新 AGENTS.md"、"更新 README"或输入 /sync-docs 时触发。完成功能开发、bug 修复、架构调整后也应主动提示使用。
用 Codex 或 Claude 帮你安装 复制这段 Prompt,粘贴到 Codex、Claude 或其他助手里,让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
Review a GitHub Pull Request for the PocketRelay project. 触发时机:用户说"review PR"、"看一下PR"、"review
分析当前 git 变更,生成符合 Conventional Commits 规范的提交。当用户说"帮我提交"、"commit 一下"、"提交代码"或输入 /commit 时触发。
开始新功能或修复前的标准流程:同步 main、切新分支、推送到远程。当用户说"开始新功能"、"切分支"、"新建分支"、"开始开发"、"new branch"或输入 /new-branch 时触发。
基于当前分支与目标分支的差异,使用 gh CLI 创建 GitHub Pull Request。当用户说"创建 PR"、"提 PR"、"开 PR"、"pr-create"或输入 /pr-create 时触发。
拉取当前 PR 所有未解决的 review 评论,分析问题并给出解决方案,询问用户是否修复。当用户说"处理 PR 评论"、"修复 review 意见"、"fix comments"、"解决评论"或输入 /pr-fix-comments 时触发。
检查当前 TypeScript Node.js 项目的工程配置完整性,识别缺失或不规范的配置项,给出完善方案并询问用户是否应用。当用户说"检查项目配置"、"审计工程配置"、"配置有什么缺失"、"完善 ts 配置"、"audit project"或输入 /ts-audit 时触发。
| name | project-sync-docs |
| description | 根据本次工作内容,同步更新项目文档,保持文档与代码实现一致。当用户说"更新文档"、"同步文档"、"文档过时了"、"更新 CLAUDE.md"、"更新 AGENTS.md"、"更新 README"或输入 /sync-docs 时触发。完成功能开发、bug 修复、架构调整后也应主动提示使用。 |
根据本次工作内容,识别哪些文档需要更新,并精准同步,避免文档与实现脱节。
| 文档 | 职责 |
|---|---|
CLAUDE.md | 项目架构、约束规范、常用命令 — 给 AI Agent 看的 |
packages/*/AGENTS.md | 各子包的关键工作点、踩坑记录、设计决策 — 接力必读 |
README.md | 用户视角的功能说明、CLI 命令、快速开始 |
docs/TODO.md | 待办事项状态(进行中 / 已完成) |
docs/*.md | 专项技术文档(构建问题、踩坑记录等) |
回顾本次工作:梳理刚完成的变更——新增了什么功能、修复了什么 bug、改了哪些架构决策、踩了哪些坑
识别需要更新的文档:对照上表,判断哪些文档的内容与当前实现不符或缺失
逐一更新,每个文档遵循以下原则:
[x],新增待办项只改有变化的部分,不要重写整个文档,不要添加没有发生的内容