226 lines
7.0 KiB
Markdown
226 lines
7.0 KiB
Markdown
# pid.md 文档更新说明
|
||
|
||
## 更新时间
|
||
2026-01-25
|
||
|
||
## 更新原因
|
||
|
||
根据技术总监的要求，将 `pid.md` 文档从技术设计文档改为纯产品需求文档（PRD），移除所有技术实现相关的内容。
|
||
|
||
## 主要变更
|
||
|
||
### 1. 文档定位变更
|
||
**更新前**: 项目信息管理系统 - 设计文档（包含技术方案）
|
||
**更新后**: 项目信息管理系统 - 产品需求文档（PRD）
|
||
|
||
### 2. 删除的内容（技术相关）
|
||
|
||
#### 2.1 技术栈章节（第1.2节）
|
||
- 删除了前端、后端、数据库等技术选型
|
||
- 删除了开发工具列表
|
||
|
||
#### 2.2 系统架构章节（第3章）
|
||
- 删除了架构图
|
||
- 删除了项目目录结构
|
||
- 删除了工作目录说明
|
||
- 删除了权限限制说明
|
||
|
||
#### 2.3 团队协作章节（第4章）
|
||
- 删除了角色职责
|
||
- 删除了工作流程
|
||
- 删除了代码提交规范
|
||
- 删除了文档规范
|
||
- 删除了沟通机制
|
||
|
||
#### 2.4 数据库设计章节（第5章）
|
||
- 删除了数据库表结构（SQL）
|
||
- 删除了角色权限矩阵
|
||
|
||
#### 2.5 API设计章节（第6章）
|
||
- 删除了所有API接口定义
|
||
- 删除了请求/响应示例
|
||
- 删除了错误码说明
|
||
|
||
#### 2.6 前端设计章节（第7章）
|
||
- 删除了页面结构
|
||
- 删除了核心组件
|
||
- 删除了页面设计细节
|
||
- 删除了UI风格
|
||
|
||
#### 2.7 安全设计章节（第8章）
|
||
- 删除了认证安全技术
|
||
- 删除了权限控制技术
|
||
- 删除了数据安全技术
|
||
|
||
#### 2.8 部署方案章节（第9章）
|
||
- 删除了开发环境部署
|
||
- 删除了生产环境部署
|
||
|
||
#### 2.9 后续优化建议章节（第10章）
|
||
- 删除了功能扩展
|
||
- 删除了性能优化
|
||
- 删除了用户体验优化
|
||
|
||
#### 2.10 开发计划章节（第11章）
|
||
- 删除了第一阶段MVP
|
||
- 删除了第二阶段功能
|
||
- 删除了第三阶段功能
|
||
|
||
### 3. 保留和优化的内容（产品需求相关）
|
||
|
||
#### 3.1 项目概述（第1章）
|
||
- **保留**: 项目背景
|
||
- **保留**: 产品目标
|
||
- **保留**: 产品特点
|
||
|
||
#### 3.2 功能需求（第2章）
|
||
- **保留**: 用户管理需求
|
||
- **保留**: 项目管理需求
|
||
- **优化**: 项目信息字段更清晰，分为多个子类（基本信息、时间信息、成本控制信息等）
|
||
- **保留**: 权限控制需求
|
||
- **新增**: 数据查询和统计需求
|
||
|
||
#### 3.3 数据管理（第3章，新增）
|
||
- **新增**: 数据导入需求
|
||
- **新增**: 数据字段说明
|
||
- **新增**: 数据验证规则
|
||
|
||
#### 3.4 用户界面需求（第4章，新增）
|
||
- **新增**: 页面结构需求
|
||
- **新增**: 功能页面需求
|
||
- **新增**: UI风格需求
|
||
|
||
#### 3.5 数据安全和隐私（第5章）
|
||
- **保留**: 用户隐私需求
|
||
- **保留**: 数据安全需求（从安全设计优化而来）
|
||
|
||
#### 3.6 非功能性需求（第6章，新增）
|
||
- **新增**: 性能要求
|
||
- **新增**: 可用性要求
|
||
- **新增**: 可维护性要求
|
||
|
||
#### 3.7 数据来源（第7章，新增）
|
||
- **新增**: 原始数据说明（example.xls）
|
||
- **新增**: 数据分类
|
||
|
||
#### 3.8 相关文档（第8章）
|
||
- **优化**: 分类整理为产品文档、技术文档、数据初始化
|
||
|
||
### 4. 文档结构调整
|
||
|
||
#### 4.1 章节数量
|
||
- **更新前**: 12章
|
||
- **更新后**: 9章
|
||
|
||
#### 4.2 新增章节
|
||
- 第3章: 数据管理（新增）
|
||
- 第4章: 用户界面需求（新增）
|
||
- 第6章: 非功能性需求（新增）
|
||
- 第7章: 数据来源（新增）
|
||
|
||
#### 4.3 章节重命名
|
||
- 第2章"功能需求"保持不变
|
||
- 第5章"数据安全和隐私"（原"安全设计"）
|
||
- 第8章"相关文档"（原"相关文档"）
|
||
|
||
### 5. 内容优化
|
||
|
||
#### 5.1 项目信息字段
|
||
- 将61个字段按功能分类展示
|
||
- 每个字段都有清晰的说明
|
||
- 分为：基本信息、时间信息、成本控制信息、合同和财务信息、应收应付信息、结算信息、项目管理信息
|
||
|
||
#### 5.2 权限控制
|
||
- 保留了权限矩阵
|
||
- 新增了字段级权限说明
|
||
- 更清晰地说明各角色的权限范围
|
||
|
||
#### 5.3 数据来源
|
||
- 新增了对example.xls的说明
|
||
- 说明了工程类别的分类
|
||
- 提供了数据导入的相关文档链接
|
||
|
||
### 6. 文档类型变更
|
||
|
||
#### 6.1 文档定位
|
||
- **更新前**: 设计文档（包含需求+技术方案）
|
||
- **更新后**: 产品需求文档（PRD）
|
||
|
||
#### 6.2 文档类型
|
||
- **更新前**: 技术文档
|
||
- **更新后**: 产品文档
|
||
|
||
### 7. 读者群体变更
|
||
|
||
#### 7.1 读者群体
|
||
- **更新前**: 技术团队（技术总监、后端程序员、前端程序员、测试工程师）
|
||
- **更新后**: 产品团队（产品经理、技术总监）、开发团队（参考需求）
|
||
|
||
#### 7.2 文档用途
|
||
- **更新前**: 技术设计和实现参考
|
||
- **更新后**: 产品需求定义和开发指导
|
||
|
||
## 文档内容对比
|
||
|
||
| 章节 | 更新前 | 更新后 | 说明 |
|
||
|------|--------|--------|------|
|
||
| 1. 项目概述 | 包含技术栈 | 产品目标、特点 | 移除技术内容 |
|
||
| 2. 功能需求 | 基础功能需求 | 详细功能需求、字段说明 | 新增数据查询统计、权限说明 |
|
||
| 3. 系统架构 | 架构图、目录结构 | 数据管理 | 完全重写 |
|
||
| 4. 团队协作 | 角色职责、工作流程 | 用户界面需求 | 完全重写 |
|
||
| 5. 数据库设计 | 表结构、SQL | 数据安全和隐私 | 完全重写 |
|
||
| 6. API设计 | API接口、请求响应 | 非功能性需求 | 完全重写 |
|
||
| 7. 前端设计 | 页面、组件 | 数据来源 | 完全重写 |
|
||
| 8. 安全设计 | 技术安全方案 | 相关文档 | 保留基础内容 |
|
||
| 9. 部署方案 | 环境部署 | - | 删除 |
|
||
| 10. 后续优化建议 | 功能、性能、用户体验 | - | 删除 |
|
||
| 11. 开发计划 | 三阶段开发计划 | - | 删除 |
|
||
| 12. 相关文档 | 文档链接 | 文档链接 | 优化分类 |
|
||
|
||
## 文档字数变化
|
||
|
||
- **更新前**: 约900行，约30,000字
|
||
- **更新后**: 约400行，约15,000字
|
||
- **精简**: 约50%
|
||
|
||
## 后续工作
|
||
|
||
### 8.1 技术文档
|
||
技术相关的内容已迁移到以下文档：
|
||
- [后端架构设计](2026-01-25-backend-architecture-design.md)
|
||
- [API文档](api.md)
|
||
- [数据库设计](../docs/database-design.md)
|
||
|
||
### 8.2 文档维护
|
||
- 产品需求变更时，需要更新本文档
|
||
- 技术实现变更时，需要更新技术文档
|
||
- 保持产品文档和技术文档的一致性
|
||
|
||
## 文档审核
|
||
|
||
### 9.1 审核人
|
||
- 技术总监：审核产品需求的完整性和合理性
|
||
- 产品经理（如有）：审核产品需求是否符合业务需求
|
||
- 开发团队：审核产品需求的可实施性
|
||
|
||
### 9.2 审核检查项
|
||
- [ ] 功能需求是否完整
|
||
- [ ] 字段定义是否清晰
|
||
- [ ] 权限控制是否合理
|
||
- [ ] 数据管理需求是否明确
|
||
- [ ] 非功能性需求是否合理
|
||
- [ ] 相关文档链接是否正确
|
||
|
||
## 总结
|
||
|
||
本次更新将 `pid.md` 从技术设计文档转换为纯产品需求文档，移除了所有技术实现相关的内容，专注于产品需求的定义和描述。文档更加精简、聚焦，便于产品团队和开发团队理解和使用。
|
||
|
||
技术相关的内容已迁移到专门的技术文档中，实现了产品文档和技术文档的分离，便于后续维护和更新。
|
||
|
||
---
|
||
|
||
**更新人**: 技术总监
|
||
**审核状态**: 待审核
|
||
**文档类型**: 产品需求文档（PRD）
|
||
**更新时间**: 2026-01-25
|