Document V2 plan in Chinese

This commit is contained in:
2026-07-06 17:02:16 +08:00
parent 4eac7351a9
commit dbd59a84df
7 changed files with 382 additions and 172 deletions

View File

@@ -1,29 +1,29 @@
# AI Knowledge Base V2 Workspace
# AI 知识库系统 V2 工作区
This folder is the new workspace for the changed requirement: **AI 企业知识库问答系统**.
这个目录用于承载新需求版本:**AI 企业知识库问答系统**。
It is intentionally separated from the existing `hy_qa_asset_backend/docs` folder because the old implementation was an MVP for "大本营答疑资产后台系统", while the new requirement is a broader AI knowledge base product with login, permission control, chat sessions, admin management, Feishu real-time retrieval, and RAG.
它和旧的 `hy_qa_asset_backend/docs` 目录刻意分开。旧项目的目标是“答疑资产后台系统”,核心是把大本营答疑内容清洗、审核、沉淀成可调用问答;新需求的目标是“企业飞书知识库 AI 问答系统”,核心是登录、权限、知识库、聊天会话、实时飞书检索和 RAG 问答。
## Directory Layout
## 目录说明
- `source_documents/`: original PRD, SRS, API, database, RAG, prototype, plan, test, UAT, deployment, data dictionary, and permission matrix files.
- `extracted/`: machine-extracted Markdown versions of the source documents for search and review.
- `development_records/`: new project development notes, decisions, scope records, and future implementation logs.
- `reports/`: assessment and design reports for this new version.
- `source_documents/`:保存原始需求资料,包括 PRDSRSAPI、数据库、RAG、后台原型、实施计划、测试、验收、部署、字段字典、权限矩阵。
- `extracted/`:从原始 Word/Excel 中抽取出的 Markdown主要用于开发检索和上下文阅读。
- `development_records/`:保存新项目开发过程记录、范围决策、架构决策、实施计划和阶段性说明。
- `reports/`:保存评估报告、方案报告和后续技术调研结论。
## Current Goal
## 当前目标
Build a new version based on the uploaded AI knowledge base requirement package:
按照已上传的 AI 知识库系统需求包,重新规划和开发一版新系统:
- User side: phone/SMS login, AI chat, sessions, history, streaming response, stop generation, Markdown rendering, and knowledge permission filtering.
- Admin side: admin login, user management, admin management, knowledge base management, Prompt management, model management, chat records, dashboard, system config, and operation logs.
- AI/RAG: Feishu knowledge base as the only knowledge source in phase one, real-time retrieval per question, permission-based knowledge filtering, Prompt assembly, model invocation, SSE streaming, and AI request logging.
- Phase-one exclusions: file upload, OCR, image understanding, web search, local vector database sync, payment, course system, automatic authorization, multi-tenant, multi-Prompt, regenerate answer, and edit message.
- 用户端手机号验证码登录、AI 聊天、多会话、历史聊天、流式回答、停止生成、Markdown 渲染、知识库权限过滤。
- 管理后台管理员登录、用户管理、管理员管理、知识库管理、Prompt 管理、模型管理、聊天记录、数据统计、系统配置、操作日志。
- AI/RAG:一期以飞书知识库作为唯一知识来源;每次提问实时检索;按用户权限过滤知识库;组装 Prompt调用大模型通过 SSE 流式输出;记录 AI 请求日志。
- 一期不做文件上传、图片理解、OCR、联网搜索、向量数据库同步、支付系统、课程系统、自动授权、多租户、多 Prompt、重新生成、编辑消息。
## Working Principles
## 工作原则
- Keep this version additive and isolated until the architecture decision is confirmed.
- Do not put new planning records into the old `hy_qa_asset_backend/docs` directory.
- Treat the uploaded documents as the source of truth for V2.
- Record major implementation decisions in `development_records/` before or alongside code changes.
- Reuse old code only where the domain boundary still matches; do not force old "QA asset review" models into the new "AI knowledge base chat" model.
- V2 先作为独立工作区推进,避免和旧项目文档混在一起。
- 上传的原始文档是 V2 的需求依据。
- 给用户、团队、交接和评审看的文档统一使用中文。
- `extracted/` 里的机器抽取文档可以保留原始语言或工程化表达,优先服务开发检索。
- 旧代码只在领域边界匹配时复用,不把旧的“答疑资产审核模型”硬套到新的“知识库权限问答模型”上。