2026-04-29-22-29-26 - 完善README.md:系统架构+技术栈+完整部署流程+常见问题

This commit is contained in:
2026-04-29 22:32:06 +08:00
parent fd4b5e5b3d
commit f41d9c20f5
5 changed files with 536 additions and 10 deletions

View File

@@ -0,0 +1,50 @@
# 需求分析 - 2026-04-29-22-29-26
## 需求来源
- 提出时间: 2026-04-29-22-29-26
- 需求类型: 文档完善
## 原始需求描述
完善 README.md在其中加入程序部署流程。
## 需求拆解
### 需求 1: 重写 README.md 项目概述
- **详细描述**: 当前 README 仍为 AI Studio 旧模板,需更新为反映全栈语义分割系统的真实定位
- **优先级**: P0-阻塞
- **影响范围**: README.md
- **验收标准**: README 开篇准确描述项目定位、核心功能、技术栈
### 需求 2: 加入系统架构图/说明
- **详细描述**: 用文本或 Markdown 表格描述前后端架构拓扑
- **优先级**: P0-阻塞
- **影响范围**: README.md
- **验收标准**: 读者可从 README 理解系统各层级关系
### 需求 3: 加入完整部署流程
- **详细描述**: 包含基础设施安装PostgreSQL/Redis/MinIO/FFmpeg、Conda 环境配置、Python 依赖安装、模型权重下载、前后端启动
- **优先级**: P0-阻塞
- **影响范围**: README.md
- **验收标准**: 新用户按 README 可独立完成从零到运行的全部部署
### 需求 4: 加入目录结构说明
- **详细描述**: 列出 backend/、src/、models/ 等关键目录的用途
- **优先级**: P1-高
- **影响范围**: README.md
- **验收标准**: 目录结构清晰,便于开发者快速定位代码
### 需求 5: 加入环境变量和配置说明
- **详细描述**: 说明 .env、backend/.env 等配置文件的作用和必填项
- **优先级**: P1-高
- **影响范围**: README.md
- **验收标准**: 配置项完整,默认值合理
## 约束条件
- 使用中文撰写 README界面已中文文档保持一致
- 不修改任何业务代码
- 保留现有 banner 图片(如有)
## 风险评估
| 风险点 | 影响 | 缓解措施 |
|--------|------|----------|
| 文档与实际代码不同步 | 中 | 基于实际已部署的代码和配置编写 |