docs: add team work plan

This commit is contained in:
2026-10-15 17:19:09 +08:00
parent 768c1c3ce9
commit 7b614397bd
3 changed files with 79 additions and 12 deletions
+1
View File
@@ -45,6 +45,7 @@ Vite 通常使用 http://localhost:5173。
- [共同开发规范](docs/CONTRIBUTING.md)
- [系统架构](docs/ARCHITECTURE.md)
- [任务分工](docs/TASKS.md)
- [三人团队工作计划](docs/TEAM_WORKPLAN.md)
- [技术决策](docs/DECISIONS.md)
目标 Gitea 仓库:`https://gitea.kronecker.cc/saint/border-red-post-nalati`。
+12 -12
View File
@@ -1,16 +1,16 @@
# 共同开发任务板(初稿)
# 共同开发任务板
> 负责人暂未指定。认领后在 Gitea Issue 中补充负责人、预计完成时间和验收记录。
> 实名分工见 [团队工作计划](TEAM_WORKPLAN.md)。每项任务仍须在 Gitea Issue 中补充预计完成时间、验收记录和关联合并请求。
| 编号 | 模块 | 任务 | 负责人 | 状态 |
|---|---|---|---|---|
| T01 | 前端 | 验证 Vue 页面启动、补充截图 | 待分配 | 待办 |
| T02 | 后端 | 验证 FastAPI `/docs`、`/api/health` | 待分配 | 待办 |
| T03 | 数据库 | 启动 PostgreSQL 并验证知识入库 | 待分配 | 待办 |
| T04 | 文档 | 明确接口字段、知识来源审核规则 | 待分配 | 待办 |
| T05 | 知识库 | 设计 sources/documents/chunks/version 表 | 待分配 | 待办 |
| T06 | 检索 | 实现关键词检索基线 | 待分配 | 待办 |
| T07 | 向量 | 评估 Embedding 并实现 pgvector | 待分配 | 待办 |
| T08 | RAG | 集成 LLM 与来源展示 | 待分配 | 待办 |
| T09 | 实验 | 构建可核验问题集及评分规范 | 待分配 | 待办 |
| T10 | 工程 | 补充测试、Alembic、鉴权与部署 | 待分配 | 待办 |
| T01 | 前端 | 验证 Vue 页面启动、补充截图 | 吉海燕 | 待办 |
| T02 | 后端 | 验证 FastAPI `/docs`、`/api/health` | 范涵宇 | 待办 |
| T03 | 数据库 | 启动 PostgreSQL 并验证知识入库 | 范涵宇 | 待办 |
| T04 | 文档 | 明确接口字段、知识来源审核规则 | 杨星萱 | 待办 |
| T05 | 知识库 | 设计 sources/documents/chunks/version 表 | 范涵宇 | 待办 |
| T06 | 检索 | 实现关键词检索基线 | 范涵宇 | 待办 |
| T07 | 向量 | 评估 Embedding 并实现 pgvector | 范涵宇 | 待办 |
| T08 | RAG | 集成 LLM 与来源展示 | 范涵宇 | 待办 |
| T09 | 实验 | 构建可核验问题集及评分规范 | 杨星萱 | 待办 |
| T10 | 工程 | 补充测试、Alembic、鉴权与部署 | 范涵宇(主)、全员 | 待办 |
+66
View File
@@ -0,0 +1,66 @@
# 三人团队工作计划
> 项目:边疆红驿那拉提文旅智能问答系统 V1.0
> 周期:2026 年 10 月 16 日—11 月 14 日
> 本计划明确主责与交付边界;主责人对任务关闭负责,配合人对自身交付物负责。
## 一、成员职责与边界
| 成员 | 角色 | 主责范围 | 主要交付物 | 边界 |
|---|---|---|---|---|
| 范涵宇 | 后端、数据库与检索负责人 | FastAPI、PostgreSQL/pgvector、数据模型、检索、RAG、部署与后端测试 | 数据库表、API、检索服务、RAG 服务、运行/部署说明 | 数据库结构和 API 字段由其主责;变更前须通知吉海燕。不得将真实密钥提交到仓库。 |
| 吉海燕 | 前端与系统集成负责人 | Vue 页面、接口调用、交互体验、异常状态、浏览器验收、演示截图 | 问答、知识管理、来源更新、实验评估页面;接口联调记录 | 前端只能通过 `/api` 访问服务,不得直连数据库或保存服务端密钥。接口字段变化须先与范涵宇确认。 |
| 杨星萱 | 知识库、实验与文档负责人 | 资料收集/核验、来源登记、测试问题集、人工评分、项目与软著文档 | 可核验资料清单、审核规范、实验记录、使用说明、软著材料初稿 | 未审核资料不得进入正式检索。不得虚构来源、实验数据或结论;不直接修改数据库结构。 |
## 二、协作约定
1. `main` 只放稳定可演示版本;`dev` 是团队集成分支;每人从 `dev` 创建 `feat/<模块>-<描述>` 分支。
2. 每项工作先建 Gitea Issue,写明负责人、验收标准、分支名和预计完成日期;完成后提交合并请求。
3. 数据库结构、Pydantic Schema、`/api` 接口字段、Embedding 模型和实验口径属于公共边界,修改前须在 Issue 中说明并通知相关成员。
4. 合并请求至少由一名非作者审查。页面改动附截图;后端改动附测试命令和结果;数据库改动附迁移/初始化说明。
5. 知识条目必须保留标题、分类、正文、来源链接、采集日期、核验状态和核验说明。杨星萱审核后,范涵宇才可纳入正式检索索引。
## 三、阶段工作与验收
| 阶段与时间 | 范涵宇:后端/数据库 | 吉海燕:前端/集成 | 杨星萱:知识库/实验/文档 | 阶段验收 |
|---|---|---|---|---|
| 阶段 1:环境联调(10/16—10/18) | 处理 Docker、WSL、PostgreSQL;验证建表、`/api/health`、知识新增/读取 | 启动 Vue,验证 API 连接和“新增知识—列表刷新”流程,补浏览器截图 | 建立资料登记模板、审核状态定义和验收记录模板 | 浏览器端可新增知识,刷新后数据仍存在;团队成员可按 README 启动 |
| 阶段 2:知识管理(10/19—10/23) | 设计并实现来源、文档、知识条目和审核相关表/API | 完成知识新增、列表、编辑、来源和审核状态页面 | 收集并登记首批 30—50 条可核验资料,完成初步分类与来源核验 | 可管理、查询并追溯首批知识;未审核条目有明确状态 |
| 阶段 3:关键词、向量与混合检索(10/24—10/29) | 实现关键词检索、Embedding Provider、pgvector 检索和 RRF 融合;记录排序与耗时 | 增加检索模式选择、检索结果/来源/耗时展示 | 编写 20—30 个测试问题,标注问题类别、期望证据与答案要点 | 同一问题能比较关键词、向量、混合三种模式,结果可复现 |
| 阶段 4:RAG 问答与来源追溯(10/30—11/3) | 接入 LLM API,完成上下文组装、提示词、知识不足提示、问答与检索日志 | 完成问答历史、引用来源卡片、加载和错误状态 | 审核回答是否受来源支持,整理正反例与失败案例 | 系统回答带来源;资料不足时不作确定性编造 |
| 阶段 5:前端完善与系统集成(11/4—11/7) | 修复接口问题,补基础自动化测试,整理配置和启动说明 | 完成四个页面的主要流程、空态、错误提示和演示路径 | 编写用户操作说明、接口验收清单和知识维护说明 | 可在浏览器完成“录入—审核—检索—问答—查看来源”主流程 |
| 阶段 6:实验与系统测试(11/8—11/11) | 固定模型/检索配置,导出检索、耗时与调用日志,修复重大缺陷 | 支持实验结果导入/展示,完成跨浏览器回归测试 | 主导 A/B/C 对照实验、人工评分、统计和案例分析 | 真实记录 LLM-only、关键词 RAG、混合检索 RAG 的正确性、可追溯性、响应时间和成本 |
| 阶段 7:软著材料与 V1.0 发布(11/12—11/14) | 清理源码、依赖、配置与部署脚本;准备发布版本 | 整理页面截图、演示流程和前端构建产物说明 | 完成用户手册、软著材料初稿、实验与资料归档 | 代码、文档、截图和实际功能一致;经全员核验后创建 `v1.0.0` 标签 |
## 四、各成员持续工作清单
### 范涵宇
- 维护后端代码质量、数据库连接和接口文档。
- 每次 API 或数据库变更后,在 Issue 中给出请求示例、响应示例和启动/迁移方式。
- 保证关键词、向量、混合检索可独立调用,并保留检索日志。
- 管理服务端环境变量,绝不提交 `.env`、API Key 或数据库真实密码。
### 吉海燕
- 所有前端请求集中在 `frontend/src/api.ts`,不在页面中散落重复请求逻辑。
- 每个后端功能完成后进行浏览器联调,记录成功、异常和空数据状态。
- 为知识管理、问答来源、实验页面保留可用于软著的清晰截图。
- 每次页面改动在合并请求中说明访问路径、测试步骤和截图。
### 杨星萱
- 建立资料来源台账,至少记录来源名称、URL、获取日期、类别、真实性判断和核验人。
- 制定“可入库/待核验/不采用”的审核规则;不确定的资料保持待核验。
- 建立测试问题集和人工评分表,实验结果必须能回溯到测试问题、检索日志和评分记录。
- 维护项目说明、用户手册、软著材料和论文实验素材,确保表述不超出系统实际功能。
## 五、完成判定
一个任务只有同时满足以下条件才能标记完成:
1. 代码或资料已进入相应分支,并有可追溯的提交和 Issue。
2. 有明确的验收步骤、测试结果或可核验资料。
3. 公共接口、文档和任务状态已同步更新。
4. 无真实密钥、个人隐私数据和未经授权的材料。
5. 合并请求通过非作者审查并合入 `dev`;阶段验收后再合入 `main`。