跳至正文

07 项目文档知识库

1. 要解决的问题

本人和开发助手需要从同一份项目资料查需求、架构、规则、进度与验收依据,并能在网页或 Obsidian 修改。目标与验收 KR 均指向workspace 项目知识库专项 PRD,不沿用业务总 PRD 的同名 KR。本能力独立排期,release 留空;实际派发和阻塞只维护在 BACKLOG 。

2. 功能

  • Nextra 在工作台内分类展示 PRD、决策、架构、计划、进度与验收,显示来源和快照版本,支持目录、关联与授权原文。
  • 同一访问规则约束目录、正文、检索、附件、下载与 AI 读取;身份允许清单缺失时关闭访问。
  • 中文检索和逐页、章节读取帮助本机 Codex 定位依据;回答能引用同版本原文,区分规格、实现和验收。
  • Editor.js 富文本视图与 Markdown 原文视图共用草稿;元数据与未知语法保留,确认发布后与 Obsidian 回到同一来源,冲突保留双方内容。

3. 做法

最小技术方案见 PROJECT §11 。现有 frontend 是唯一网页入口;采用 Nextra 编译与文档组件,复用布局、身份与 CSRF,knowledge 项目文档切片经生成客户端供给数据。正文受控渲染,Editor.js 块映射到原文,未支持格式保留原文视图;普通 Markdown 是唯一作者来源。

作者文件、不可变阅读快照和编辑草稿各有明确职责;BACKLOG、PROJECT、AGENTS 保持根文件唯一原文。Nextra 公开预览仅保留公开清单内容,公开清单不承担内部权限;新增私密来源不进入公开仓库与静态产物。

4. 现状

工作台入口、文档权限、网页编辑与本地发布实现已加入本轮工作区,真实账号、Obsidian 与 AI 验收尚未完成,能力状态继续为“未开始”。文档分类、编号校验与独立预览工具已有工程验证,见 VERIFICATION ;Nextra 依赖仍在,内部动态读取属于本次实现。这些结果不能替代本能力的真实使用验收。任务状态及外部条件见 BACKLOG。

Nextra 与 Editor.js 已用于本机入口,段落和标题支持富文本,表格、Mermaid、代码及未知语法保留原文;工程证据与真实双端操作分别记录。Notion 路线仅作替代评估,尚未连接账号或迁移文档。

5. 验收标准

  1. 阅读阶段通过专项 PRD 的 KR1、KR2:按登记清单核对正文、附件、相对链接、章节与根文件;目标环境验证统一样式、所有读取出口权限及冷启动、恢复。
  2. AI 阶段通过 KR3、KR4:保留固定查询和实际问题的逐项结果、源版本和引用,包含全部规定的边界问题;使用真实本机 Codex 复核。
  3. 编辑阶段通过 KR5、KR6:实际网页和 Obsidian 完成全部双向样本,异常和并发场景保留可恢复内容、没有静默覆盖;草稿、操作与发布快照经重启复核。

完整阈值、样本数量与阶段门槛以专项 PRD 为准,不在本文件另定更低标准。每阶段工程检查、规格审查与真实验收分别记录;全部相关前置和 KR 达成后才更新相应能力状态。

6. 不做什么

  • 不扩展业务公开分发,不把项目资料加入业务报告知识库或公开 MCP。
  • 不另建账号体系、向量数据库、多人实时协同或跨项目平台。
  • 不采用 GitBook;保留既有 Nextra 公开预览,内部入口复用 frontend;workspace 保留作者文档与校验、快照工具。
  • 不让同步流程提交当前开发目录中的其他代码修改,不把预览工具通过说成双端编辑可用。

验收记录

正式记录放在 records/,capability 指向本文,按上述三项验收标准登记;当前尚无本能力的真实验收记录。

原始 Markdown