fujian_water_biz_doc/QUICK_START.md

🚀 福建水务营收系统概要设计文档 - 快速入门

5分钟快速体验

第1步：查看项目状态（30秒）

# 查看项目当前状态
cat project_progress.md

预期输出：

项目进度跟踪信息，包含各文档完成状态

第2步：查看任务清单（1分钟）

# 查看待完成任务
cat task_checklist.md

预期输出：

当前阶段的所有待完成任务，包含优先级和状态

第3步：开始编辑文档（30秒）

# 打开系统架构设计文档
code water_biz_system_architecture.md

第4步：查看项目看板（1分钟）

# 查看项目整体看板
cat project_dashboard.md

第5步：开始工作（1分钟）

根据任务优先级，开始编辑相应的设计文档：

• 📝 系统架构：water_biz_system_architecture.md
• 🗄️ 数据库设计：water_biz_database_design.md
• 🔌 接口设计：water_biz_interface_design.md

完整文档编写流程

第一阶段：紧急问题修复

# 查看第一阶段任务
grep -A 10 "第一阶段" task_checklist.md

# 按优先级编辑文档
code water_biz_system_architecture.md    # 添加架构图
code water_biz_database_design.md        # 完善DDL语句
code water_biz_interface_design.md       # 详化接口参数

第二阶段：内容完善

# 查看第二阶段任务
grep -A 10 "第二阶段" task_checklist.md

# 完善业务设计
# 编辑各个模块的业务流程图和技术方案

在VS Code中使用

1. 打开项目：

   code .
   

2. 运行任务：

   • 按 Ctrl+Shift+P (或 Cmd+Shift+P)
   • 输入 "Tasks: Run Task"
   • 选择需要的任务（如"验证所有文档"）

3. 实时预览：

   • 安装推荐扩展
   • 编辑Markdown文件时自动显示预览

高效工作流程

日常文档编写流程

# 1. 查看当前进度
cat project_progress.md

# 2. 查看待完成任务
cat task_checklist.md

# 3. 编写内容（使用VS Code或其他编辑器）
code water_biz_模块名_design.md

# 4. 更新项目状态
# 编辑完成后需要手动更新project_progress.md中的完成度

# 5. 版本控制
git add .
git commit -m "完成模块设计文档更新"

团队协作流程

# 1. 更新代码
git pull origin main

# 2. 创建功能分支
git checkout -b feature/文档模块优化

# 3. 编写文档
# 根据task_checklist.md中的任务进行编写
# ... 编写内容 ...

# 4. 更新项目管理文件
# 更新project_progress.md和task_checklist.md中的状态

# 5. 提交和推送
git add .
git commit -m "完成文档模块设计更新"
git push origin feature/文档模块优化

# 6. 创建PR/MR

常用命令速查

项目状态查看

cat project_progress.md            # 查看项目进度
cat task_checklist.md             # 查看任务清单
cat project_dashboard.md          # 查看项目看板
cat delivery_standards.md         # 查看交付标准

文档编辑

code water_biz_system_architecture.md    # 编辑系统架构
code water_biz_database_design.md        # 编辑数据库设计
code water_biz_interface_design.md       # 编辑接口设计
code water_biz_module_design.md          # 编辑模块设计
code water_biz_deployment_design.md      # 编辑部署设计

进度管理

# 查看具体文档状态
grep "water_biz_system_architecture" project_progress.md
grep "water_biz_database_design" project_progress.md

任务筛选

grep "🔴 高优先级" task_checklist.md      # 查看高优先级任务
grep "⏳ 待开始" task_checklist.md       # 查看待开始任务
grep "🟡 进行中" task_checklist.md       # 查看进行中任务

疑难解答

问题1：不知道从哪开始

# 解决方案：查看项目看板了解当前状态
cat project_dashboard.md

问题2：不清楚任务优先级

# 解决方案：查看任务清单中的优先级标记
grep "🔴 高优先级" task_checklist.md

问题3：文档编辑后忘记更新状态

# 解决方案：编辑完成后记得更新项目进度
code project_progress.md

下一步

恭喜！您已经掌握了文档编写的基本流程。

继续阅读：

• 📋 项目进度跟踪
• 📝 任务清单
• 📊 项目看板
• ⚙️ Cursor Rules说明

---

💡 提示：将本页面加入书签，随时查看快速入门流程！