mirror of
https://github.com/kuaifan/dootask.git
synced 2026-08-12 07:48:33 +00:00
ec1ab31b0e
- 删除 CI reindex workflow（ai-kb-reindex.yml）：内容入库不再依赖 CI 远程触发，AI 插件容器每次启动按文件 hash 对账（reconcile）自动增量 收敛，免重启即时生效时可手动调 POST /kb/reindex（默认 mode=reconcile） - ai-kb README.md 同步更新贡献流程与内容同步机制说明 - CLAUDE.md 精简 ai-kb 同步规则：去除与 _schema/README 重复的写作规范 与背景说明，保留同步时机、操作指引、改完无需触发索引三条 - 另：auth 接口 locale 检索语种缺省改为由请求语言推导（含 zh 视为 zh， 否则 en），删除 config/ai.php 的 rag_supported_locales 与回退逻辑， 前端改用 getLanguage() 统一映射，同步更新 ai-kb auth.md - appstore 镜像升级 0.4.3 -> 0.5.0 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
ai-kb — DooTask AI 助手知识库
这是专为大语言模型（LLM）检索使用的 DooTask 功能知识库，不是给人类阅读的产品文档（那个在 dootask-website 仓库的 help/docs）。
它的唯一消费者是 AI 助手：用户问"看板列怎么改名 / 审批可以分支吗 / 5.4 有什么新功能"时，助手通过 RAG 检索这里的内容来作答。
目录结构
ai-kb/
├── _schema/ 写作规范（必读）
│ ├── frontmatter.md frontmatter 字段规范 + 受控词表
│ └── chunk-style.md chunk 写作风格 + 正反例
├── _meta/ 元数据（lint / eval 脚本读取）
│ ├── feature-map.yaml feature 全集 + 每个 feature 的 chunk 清单
│ └── tool-binding.yaml chunk ↔ MCP 工具映射
├── _eval/ 回归测试
│ └── golden-50q.yaml 50 题评估集
├── zh/ 中文知识库（P0 主战场）
│ ├── concept/ 「是什么」
│ ├── howto/ 「怎么做」（含 apps/ 子目录覆盖应用中心）
│ ├── faq/ 「为什么 / 出错怎么办」
│ ├── menu-map/ 「X 入口在哪」
│ ├── glossary/ 术语 + 别名
│ └── shortcut/ 快捷键、移动端手势
└── en/ 英文知识库（P1 起草，P0 保留空目录）
为什么不复用 dootask-website 的人类文档
| 维度 | 人类文档 | ai-kb |
|---|---|---|
| 阅读单位 | 一篇文章 | 一个 chunk（128-512 token） |
| 自包含性 | 假设从头读 | 每个 chunk 独立可懂 |
| 跨章节指代 | 「如上图所示」可以 | 禁止 |
| 截图 | 必要 | 禁止依赖（用文字描述） |
| 同义词 | 一处定义 | 显式列别名 |
| 否定信息 | 少 | 必备 |
| 元数据 | 标题即可 | 严格 frontmatter |
直接对人类文档做 RAG 召回率低、易编造，所以这里独立维护。
怎么开始写一个 chunk
- 通读
_schema/frontmatter.md— 字段规范与受控词表 - 通读
_schema/chunk-style.md— 写作风格与正反例 - 在
_meta/feature-map.yaml找到对应 feature 的 chunk 清单和归属批次 - 在对应
zh/<type>/<feature>/<id>.md路径下新建文件 - 提交 PR、review 后合入。内容进索引不需要额外操作：AI 插件容器每次启动会按文件 hash 对账（reconcile），自动增量收敛新增/变更/删除；想免重启即时生效可手动调
POST /kb/reindex
改 DooTask 主程序后必须同步更新这里
这是硬性约束 —— 详见主仓库根目录 CLAUDE.md 中「DooTask AI 知识库 (ai-kb) 同步规则」章节。新增/修改/删除任何用户可见的功能、菜单、按钮、流程、字段、API 行为、权限角色，都必须在同一 PR里更新对应 chunk 并把 frontmatter 的 last_verified 改成当前版本号。
不更新的代价是 AI 助手给用户讲错路径，比 PR 多写两行成本高得多。
工程接口（代码在 AI 插件那一侧）
ingest、检索、lint、eval 的实现在 dootask-plugins/system-plugins/ai/src/helper/kb/。本目录纯内容，不放 Python 代码。
AI 插件容器通过只读 volume mount 看到本目录：
volumes:
- ../../../dootask/resources/ai-kb:/app/kb-content:ro
内容同步机制：容器每次启动按文件 hash 对账（reconcile），自动增量收敛新增/变更/删除的 markdown——客户实例更新 DooTask 后重启插件容器即生效。需要免重启即时生效时手动触发：
curl -X POST 'http://ai-service/kb/reindex' \
-H "X-Ingest-Token: $KB_INGEST_TOKEN" \
-d '{"mode":"reconcile"}'
维护责任
- 内容：产品功能负责人 / PM / 技术写作者按
_meta/feature-map.yaml中的owner列认领 - schema 与受控词表：架构组维护，修改需走 PR
- lint / ingest / retriever 代码：AI 插件维护组