wehub-skill-sync
2.4 KiB
2.4 KiB
文档维护审核清单
在审核每个目标文档时，请使用此清单。对照 git 历史中的变更摘要逐一检查各项。
README.md
功能特性表格
- 每个功能卡片均对应一项已发布的能力
- 不存在对应尚未实现功能的功能卡片
- 表格中未遗漏任何已发布的主要功能
路线图
- 已发布的功能不再标记为"计划中"或"即将推出"
- 已移除/已取消的项目未仍在列表中
- 项目反映当前优先级（与近期 PR 交叉核对）
快速开始
npx paperclipai onboard命令正确- 手动安装步骤准确（克隆 URL、命令）
- 前提条件（Node 版本、pnpm 版本）为当前最新
- 服务器 URL 和端口正确
"Paperclip 是什么" 部分
- 高层级描述准确
- 步骤表格（定义目标 / 组建团队 / 批准并运行）正确
"兼容" 表格
- 列出所有支持的适配器/运行时
- 已移除的适配器未仍在列表中
- Logo 和标签与当前适配器名称一致
"Paperclip 适合你，如果……"
- 用例描述仍然准确
- 不包含对不存在功能的声称
"Paperclip 的特别之处"
- 技术声明准确（原子执行、治理等）
- 未列出已移除或重大变更的功能
常见问题解答
- 答案仍然正确
- 不涉及已移除的功能或过时的行为
开发部分
- 命令准确（
pnpm dev、pnpm build等） - 指向 DEVELOPING.md 的链接正确
doc/SPEC.md
公司模型
- 字段与当前架构一致
- 治理模型描述准确
代理模型
- 适配器类型与实际支持的匹配
- 代理配置描述准确
- 已发布的功能不再描述为"不支持"或"非 V1"
任务模型
- 任务层级结构描述准确
- 状态值与当前实现一致
扩展 / 插件
- 如果插件已发布，不再使用"非 V1"或"未来"等措辞
- 插件模型描述与实现一致
待定问题
- 已解决的问题已移除或更新
- 已决策的事项不再标注为"待定"
doc/PRODUCT.md
核心概念
- 公司、员工、任务管理描述准确
- 代理执行模式描述正确
- 未遗漏主要概念
原则
- 原则未与已发布的功能相矛盾
- 不存在引用已移除能力的原则
用户流程
- 理想场景仍能反映实际的上手流程
- 各步骤在当前功能下均可实现