admin/Control-Valve-Factory-Information-Management-System-Project
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Format all project startup docs with Prettier

Browse Source 
- Add Prettier as dev dependency
- Apply formatting to interview map, retrospective, and planning document

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
Misaka
2026-04-12 17:11:14 +08:00
parent 9c4feb5dce
commit 6462cd8873
5 changed files with 95 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/01-项目启动/项目复盘.md
View File

@@ -41,6 +41,7 @@
### 结构设计 ### 结构设计
最终确定的结构是**两层**： 最终确定的结构是**两层**：
- 第一层：模块划分，按业务流向排列（订单 → 技术 → 采购 → 仓库 → 生产 → 发货） - 第一层：模块划分，按业务流向排列（订单 → 技术 → 采购 → 仓库 → 生产 → 发货）
- 第二层：每个模块内 2～4 个引导问题 + 每题附备注（说明提问目的） - 第二层：每个模块内 2～4 个引导问题 + 每题附备注（说明提问目的）
@@ -168,15 +169,15 @@
项目文档使用 Git 进行版本管理，所有变更可追溯。当前各文档最新版本如下： 项目文档使用 Git 进行版本管理，所有变更可追溯。当前各文档最新版本如下：
| 文档名称 | 当前版本 | 主要内容 | | 文档名称 | 当前版本 | 主要内容 |
|---------|---------|---------| | ---------------- | -------- | -------------------------------------- |
| 项目讨论复盘 | v2 | 覆盖两轮讨论的完整复盘 | | 项目讨论复盘 | v2 | 覆盖两轮讨论的完整复盘 |
| 项目规划文档 | v1.5 | 含前端部署策略、早期Demo、客户配合事项 | | 项目规划文档 | v1.5 | 含前端部署策略、早期Demo、客户配合事项 |
| 调研访谈对话地图 | v2.2 | 含系统环境调研、Office版本与网络情况 | | 调研访谈对话地图 | v2.2 | 含系统环境调研、Office版本与网络情况 |
| 成本与报价分析 | 待启动 | 单独文档，初稿后交领导讨论 | | 成本与报价分析 | 待启动 | 单独文档，初稿后交领导讨论 |
| 客户演示 PPT | 待启动 | 基于规划文档制作，调研后启动 | | 客户演示 PPT | 待启动 | 基于规划文档制作，调研后启动 |
| 项目边界备忘录 | 待启动 | 建议调研后、开发前与客户书面确认 | | 项目边界备忘录 | 待启动 | 建议调研后、开发前与客户书面确认 |
--- ---
*复盘文档 · v2 · 整理自项目前期讨论过程 · 供内部参考* _复盘文档 · v2 · 整理自项目前期讨论过程 · 供内部参考_

75
docs/01-项目启动/项目规划文档.md
View File

@@ -31,12 +31,12 @@
### 主要技术栈 ### 主要技术栈
| 技术 | 用途 | 说明 | | 技术 | 用途 | 说明 |
|------|------|------| | --------------------- | ------------------------------- | ------------------------------------------------------------------------------ |
| Microsoft Excel + VBA | 界面与业务逻辑 | 无需额外环境，部署简单，客户熟悉度高 | | Microsoft Excel + VBA | 界面与业务逻辑 | 无需额外环境，部署简单，客户熟悉度高 |
| Microsoft Access | 数据存储与应用界面（可选方案A） | 与 Office 生态集成，兼具数据库和界面开发能力，部署简单，但存在并发和稳定性局限 | | Microsoft Access | 数据存储与应用界面（可选方案A） | 与 Office 生态集成，兼具数据库和界面开发能力，部署简单，但存在并发和稳定性局限 |
| SQL Server Express | 数据存储（可选方案B） | 微软出品，免费，稳定性和并发能力显著优于 Access，但部署复杂度更高 | | SQL Server Express | 数据存储（可选方案B） | 微软出品，免费，稳定性和并发能力显著优于 Access，但部署复杂度更高 |
| Python | 辅助脚本与自动化 | 用于 VBA 难以处理的复杂逻辑，按需引入 | | Python | 辅助脚本与自动化 | 用于 VBA 难以处理的复杂逻辑，按需引入 |
### 数据库方案对比 ### 数据库方案对比
@@ -47,12 +47,14 @@
适用场景：单机使用，或并发用户数极少（1～2人）的情况。 适用场景：单机使用，或并发用户数极少（1～2人）的情况。
优点： 优点：
- 无需额外安装数据库服务，部署极为简单 - 无需额外安装数据库服务，部署极为简单
- 自带窗体和报表设计器，可作为应用界面直接使用，减少开发工作量 - 自带窗体和报表设计器，可作为应用界面直接使用，减少开发工作量
- 与 Excel、VBA 集成度高，开发门槛低 - 与 Excel、VBA 集成度高，开发门槛低
- 客户已有 Office 环境即可运行，无额外软件成本 - 客户已有 Office 环境即可运行，无额外软件成本
局限性： 局限性：
- 文件型数据库，多人并发写入时存在文件损坏风险，数据一旦损坏难以恢复 - 文件型数据库，多人并发写入时存在文件损坏风险，数据一旦损坏难以恢复
- 并发性能较弱，不适合多人同时操作的场景 - 并发性能较弱，不适合多人同时操作的场景
- 数据量增大后性能下降明显，长期扩展性有限 - 数据量增大后性能下降明显，长期扩展性有限
@@ -62,12 +64,14 @@
适用场景：多人共享访问，对数据稳定性有要求的生产环境。 适用场景：多人共享访问，对数据稳定性有要求的生产环境。
优点： 优点：
- 微软官方出品，Express 版本免费，功能满足本项目体量 - 微软官方出品，Express 版本免费，功能满足本项目体量
- 真正的服务型数据库，支持多人并发访问，稳定性高 - 真正的服务型数据库，支持多人并发访问，稳定性高
- 数据存储在服务器端，不依赖单个文件，安全性和可靠性远优于 Access - 数据存储在服务器端，不依赖单个文件，安全性和可靠性远优于 Access
- 后期若系统规模扩大，可平滑升级至 SQL Server 完整版，无需重构 - 后期若系统规模扩大，可平滑升级至 SQL Server 完整版，无需重构
局限性： 局限性：
- 需要在服务器上安装和配置数据库服务，部署复杂度高于 Access - 需要在服务器上安装和配置数据库服务，部署复杂度高于 Access
- 需要服务器支撑（操作系统建议使用 Windows Server，普通 Windows 系统对局域网并发连接数有约20个的上限限制） - 需要服务器支撑（操作系统建议使用 Windows Server，普通 Windows 系统对局域网并发连接数有约20个的上限限制）
- 界面部分仍需通过 Excel + VBA 开发，无法像 Access 一样直接利用内置界面工具 - 界面部分仍需通过 Excel + VBA 开发，无法像 Access 一样直接利用内置界面工具
@@ -187,9 +191,11 @@ graph TD
--- ---
### 第一阶段：调研与需求确认 ### 第一阶段：调研与需求确认
**时间：第1～3周（约3周）** **时间：第1～3周（约3周）**
**工作内容** **工作内容**
- 与客户开展调研访谈，覆盖全部业务模块 - 与客户开展调研访谈，覆盖全部业务模块
- 记录客户当前各环节的操作方式和痛点 - 记录客户当前各环节的操作方式和痛点
- 确认各模块的具体需求和优先级 - 确认各模块的具体需求和优先级
@@ -198,12 +204,14 @@ graph TD
- 输出需求确认文档，作为后续开发的依据 - 输出需求确认文档，作为后续开发的依据
**产出物** **产出物**
- 客户现状调研记录 - 客户现状调研记录
- 系统需求确认文档（各模块字段、流程、规则） - 系统需求确认文档（各模块字段、流程、规则）
- 物料编码规则草案 - 物料编码规则草案
- 客户现有数据摸底报告（数据源清单、数据规模、质量评估、迁移难度判断） - 客户现有数据摸底报告（数据源清单、数据规模、质量评估、迁移难度判断）
**阶段目标** **阶段目标**
- 双方对系统要做什么达成一致 - 双方对系统要做什么达成一致
- 物料编码体系的设计方向确定，可进入开发阶段 - 物料编码体系的设计方向确定，可进入开发阶段
- 对客户现有数据的规模和质量有清晰认知，为第二阶段的数据整理工作做好预判 - 对客户现有数据的规模和质量有清晰认知，为第二阶段的数据整理工作做好预判
@@ -211,9 +219,11 @@ graph TD
--- ---
### 第二阶段：基础数据层建设 ### 第二阶段：基础数据层建设
**时间：第4～8周（约5周）** **时间：第4～8周（约5周）**
**工作内容** **工作内容**
- 设计并确认物料编码规则 - 设计并确认物料编码规则
- 搭建物料主数据管理模块（录入界面 + 数据库） - 搭建物料主数据管理模块（录入界面 + 数据库）
- 设计 BOM 数据结构，搭建 BOM 管理模块 - 设计 BOM 数据结构，搭建 BOM 管理模块
@@ -221,6 +231,7 @@ graph TD
- 在基础数据初步录入后，尽早搭建一个可演示的小型功能点（如物料查询界面），供客户实际体验，建立对系统的直观感知和信心 - 在基础数据初步录入后，尽早搭建一个可演示的小型功能点（如物料查询界面），供客户实际体验，建立对系统的直观感知和信心
**产出物** **产出物**
- 物料编码规则文档 - 物料编码规则文档
- 可用的物料主数据管理模块 - 可用的物料主数据管理模块
- 可用的 BOM 管理模块 - 可用的 BOM 管理模块
@@ -228,6 +239,7 @@ graph TD
- 可演示的早期 Demo（如物料查询功能） - 可演示的早期 Demo（如物料查询功能）
**阶段目标** **阶段目标**
- 物料编码体系落地，数据库中有真实可用的物料数据 - 物料编码体系落地，数据库中有真实可用的物料数据
- 为后续所有模块提供数据基础 - 为后续所有模块提供数据基础
- 客户能够通过早期 Demo 看到实际成果，对项目方向建立信心 - 客户能够通过早期 Demo 看到实际成果，对项目方向建立信心
@@ -235,49 +247,59 @@ graph TD
--- ---
### 第三阶段：库存与采购模块 ### 第三阶段：库存与采购模块
**时间：第9～12周（约4周）** **时间：第9～12周（约4周）**
**工作内容** **工作内容**
- 搭建库存管理模块（入库、出库、库存查询、预警） - 搭建库存管理模块（入库、出库、库存查询、预警）
- 搭建采购管理模块（采购单、供应商、到货确认） - 搭建采购管理模块（采购单、供应商、到货确认）
- 实现库存与采购的数据联动 - 实现库存与采购的数据联动
- 与客户对接，验证流程是否符合实际操作习惯 - 与客户对接，验证流程是否符合实际操作习惯
**产出物** **产出物**
- 可用的库存管理模块 - 可用的库存管理模块
- 可用的采购管理模块 - 可用的采购管理模块
- 两模块的操作说明文档 - 两模块的操作说明文档
**阶段目标** **阶段目标**
- 客户可以通过系统管理日常的入库、出库、采购操作 - 客户可以通过系统管理日常的入库、出库、采购操作
- 库存数据可实时查询，告别依靠记忆和人工盘点 - 库存数据可实时查询，告别依靠记忆和人工盘点
--- ---
### 第四阶段：订单与生产模块 ### 第四阶段：订单与生产模块
**时间：第13～17周（约5周）** **时间：第13～17周（约5周）**
**工作内容** **工作内容**
- 搭建订单管理模块（订单录入、状态跟踪、交货期） - 搭建订单管理模块（订单录入、状态跟踪、交货期）
- 搭建生产管理模块（工单、进度、领料） - 搭建生产管理模块（工单、进度、领料）
- 实现订单 → 生产 → 库存的数据联动 - 实现订单 → 生产 → 库存的数据联动
- 测试完整业务流程的数据流转是否顺畅 - 测试完整业务流程的数据流转是否顺畅
**产出物** **产出物**
- 可用的订单管理模块 - 可用的订单管理模块
- 可用的生产管理模块 - 可用的生产管理模块
- 完整业务流程的数据流转测试记录 - 完整业务流程的数据流转测试记录
**阶段目标** **阶段目标**
- 系统可以覆盖从接单到生产完成的完整流程 - 系统可以覆盖从接单到生产完成的完整流程
- 各环节数据可以贯通，不再孤立 - 各环节数据可以贯通，不再孤立
--- ---
### 第五阶段：发货模块与系统整合交付 ### 第五阶段：发货模块与系统整合交付
**时间：第18～20周（约3周）** **时间：第18～20周（约3周）**
**工作内容** **工作内容**
- 搭建发货管理模块（出库确认、发货单、发货记录） - 搭建发货管理模块（出库确认、发货单、发货记录）
- 全系统整合测试，修复问题 - 全系统整合测试，修复问题
- 数据迁移协助（将客户现有 Excel 数据导入系统） - 数据迁移协助（将客户现有 Excel 数据导入系统）
@@ -285,12 +307,14 @@ graph TD
- 交付系统及相关文档 - 交付系统及相关文档
**产出物** **产出物**
- 可用的发货管理模块 - 可用的发货管理模块
- 完整可交付的信息化管理系统 - 完整可交付的信息化管理系统
- 用户操作手册 - 用户操作手册
- 系统维护说明文档 - 系统维护说明文档
**阶段目标** **阶段目标**
- 系统全流程打通，覆盖接单到发货的完整业务链 - 系统全流程打通，覆盖接单到发货的完整业务链
- 客户可以独立使用系统，完成日常业务操作 - 客户可以独立使用系统，完成日常业务操作
@@ -298,13 +322,13 @@ graph TD
## 五、时间节点总览 ## 五、时间节点总览
| 阶段 | 主要内容 | 时间区间 | 关键产出 | | 阶段 | 主要内容 | 时间区间 | 关键产出 |
|------|---------|---------|---------| | -------- | --------------- | ---------- | --------------------------- |
| 第一阶段 | 调研与需求确认 | 第1～3周 | 需求确认文档、数据摸底报告 | | 第一阶段 | 调研与需求确认 | 第1～3周 | 需求确认文档、数据摸底报告 |
| 第二阶段 | 物料编码 + BOM | 第4～8周 | 物料与BOM模块上线、早期Demo | | 第二阶段 | 物料编码 + BOM | 第4～8周 | 物料与BOM模块上线、早期Demo |
| 第三阶段 | 库存 + 采购 | 第9～12周 | 库存采购模块上线 | | 第三阶段 | 库存 + 采购 | 第9～12周 | 库存采购模块上线 |
| 第四阶段 | 订单 + 生产 | 第13～17周 | 订单生产模块上线 | | 第四阶段 | 订单 + 生产 | 第13～17周 | 订单生产模块上线 |
| 第五阶段 | 发货 + 整合交付 | 第18～20周 | 完整系统交付 | | 第五阶段 | 发货 + 整合交付 | 第18～20周 | 完整系统交付 |
**总周期：约20周（5个月）** **总周期：约20周（5个月）**
@@ -312,16 +336,16 @@ graph TD
## 六、风险识别与应对 ## 六、风险识别与应对
| 风险 | 说明 | 应对方式 | | 风险 | 说明 | 应对方式 |
|------|------|---------| | ----------------- | ------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| 需求变更 | 调研不充分导致开发中途改需求 | 第一阶段重点投入，确保需求文档经双方确认后再开发 | | 需求变更 | 调研不充分导致开发中途改需求 | 第一阶段重点投入，确保需求文档经双方确认后再开发 |
| 数据录入量大 | 存量物料数据录入可能耗时超预期 | 第一阶段完成数据摸底，提前评估工作量；协助客户设计数据整理模板，分批录入，不影响开发进度 | | 数据录入量大 | 存量物料数据录入可能耗时超预期 | 第一阶段完成数据摸底，提前评估工作量；协助客户设计数据整理模板，分批录入，不影响开发进度 |
| 客户使用习惯 | 员工不习惯新系统，使用率低 | 界面设计贴近 Excel 操作习惯，降低学习成本，上线前做培训；尽早提供可体验的 Demo，让客户逐步适应 | | 客户使用习惯 | 员工不习惯新系统，使用率低 | 界面设计贴近 Excel 操作习惯，降低学习成本，上线前做培训；尽早提供可体验的 Demo，让客户逐步适应 |
| 并发访问限制 | 普通 Windows 系统对局域网并发连接数有上限，多人同时使用时可能出现连接被拒的情况 | 服务器操作系统必须使用 Windows Server，在项目启动前与客户确认并推动采购落实 | | 并发访问限制 | 普通 Windows 系统对局域网并发连接数有上限，多人同时使用时可能出现连接被拒的情况 | 服务器操作系统必须使用 Windows Server，在项目启动前与客户确认并推动采购落实 |
| 数据库稳定性 | Access 文件型数据库在多人并发写入时存在文件损坏的风险，一旦损坏数据难以恢复 | 采用 SQL Server Express 替代 Access 作为数据库，从根本上规避此风险 | | 数据库稳定性 | Access 文件型数据库在多人并发写入时存在文件损坏的风险，一旦损坏数据难以恢复 | 采用 SQL Server Express 替代 Access 作为数据库，从根本上规避此风险 |
| 开发时间有限 | 技术实施以业余时间为主 | 借助 AI 辅助开发提升效率，各阶段设置缓冲时间，优先保证核心模块 | | 开发时间有限 | 技术实施以业余时间为主 | 借助 AI 辅助开发提升效率，各阶段设置缓冲时间，优先保证核心模块 |
| Office 版本不一致 | 不同工作站 Office 版本不同，可能导致 VBA 程序出现兼容性问题 | 调研阶段摸清各工作站 Office 版本，推动客户在项目启动前统一 Office 版本 | | Office 版本不一致 | 不同工作站 Office 版本不同，可能导致 VBA 程序出现兼容性问题 | 调研阶段摸清各工作站 Office 版本，推动客户在项目启动前统一 Office 版本 |
| 应用分发与更新 | 系统迭代后需将新版本分发到各工作站，若缺乏机制可能导致版本混乱 | 采用一人一份应用文件的设计，应用内置版本标识；结合客户 IT 环境确定分发机制（如共享文件夹存放最新版） | | 应用分发与更新 | 系统迭代后需将新版本分发到各工作站，若缺乏机制可能导致版本混乱 | 采用一人一份应用文件的设计，应用内置版本标识；结合客户 IT 环境确定分发机制（如共享文件夹存放最新版） |
--- ---
@@ -330,17 +354,20 @@ graph TD
> **说明：** 以下事项需要客户方配合完成，建议在项目启动前或调研阶段与客户明确沟通，形成书面备忘，避免后期因预期不对齐产生分歧。 > **说明：** 以下事项需要客户方配合完成，建议在项目启动前或调研阶段与客户明确沟通，形成书面备忘，避免后期因预期不对齐产生分歧。
**项目启动前需客户配合确认的事项：** **项目启动前需客户配合确认的事项：**
- 是否同意将各工作站 Office 统一到同一版本（我方指定），并在项目开发启动前完成 - 是否同意将各工作站 Office 统一到同一版本（我方指定），并在项目开发启动前完成
- 是否已有服务器或是否愿意采购服务器（若选择 SQL Server 方案） - 是否已有服务器或是否愿意采购服务器（若选择 SQL Server 方案）
- 指定一名内部对接人，负责协调访谈安排、数据收集和日常沟通 - 指定一名内部对接人，负责协调访谈安排、数据收集和日常沟通
**项目实施过程中需客户配合的事项：** **项目实施过程中需客户配合的事项：**
- 安排相关岗位人员参与调研访谈 - 安排相关岗位人员参与调研访谈
- 配合整理现有物料、BOM 等存量数据，按模板格式提供 - 配合整理现有物料、BOM 等存量数据，按模板格式提供
- 每个阶段交付时安排人员进行试用和反馈 - 每个阶段交付时安排人员进行试用和反馈
- 系统上线前安排员工参与使用培训 - 系统上线前安排员工参与使用培训
**建议形成书面备忘的事项：** **建议形成书面备忘的事项：**
- 系统包含哪些模块、不包含哪些（明确项目边界） - 系统包含哪些模块、不包含哪些（明确项目边界）
- 交付后的维护和修改如何处理（响应方式、是否收费） - 交付后的维护和修改如何处理（响应方式、是否收费）
- 客户方需承担的配合责任（数据整理、硬件采购、版本统一等） - 客户方需承担的配合责任（数据整理、硬件采购、版本统一等）
@@ -357,4 +384,4 @@ graph TD
--- ---
*内部工作文件 · v1.5 · 可根据调研结果和项目进展持续更新* _内部工作文件 · v1.5 · 可根据调研结果和项目进展持续更新_

28
package-lock.json generated Normal file
View File

@@ -0,0 +1,28 @@
{
"name": "Control-Valve-Factory-Information-Management-System-Project",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"devDependencies": {
"prettier": "^3.8.2"
}
},
"node_modules/prettier": {
"version": "3.8.2",
"resolved": "https://registry.npmjs.org/prettier/-/prettier-3.8.2.tgz",
"integrity": "sha512-8c3mgTe0ASwWAJK+78dpviD+A8EqhndQPUBpNUIPt6+xWlIigCwfN01lWr9MAede4uqXGTEKeQWTvzb3vjia0Q==",
"dev": true,
"license": "MIT",
"bin": {
"prettier": "bin/prettier.cjs"
},
"engines": {
"node": ">=14"
},
"funding": {
"url": "https://github.com/prettier/prettier?sponsor=1"
}
}
}
}

5
package.json Normal file
View File

@@ -0,0 +1,5 @@
{
"devDependencies": {
"prettier": "^3.8.2"
}
}