Skip to content

历史资料说明:本文保留用于版本、制作或技术历史查阅,不作为沐霖 V4.5.0 当前产品功能说明。当前产品以项目工时记录、审核和统计为核心,任务相关功能已移除。

SVG 示意图插入完成总结 ​

✅ 已完成所有文档的 SVG 插入 ​

所有 7 个使用指南章节的文档都已成功插入对应的 SVG 示意图,并标注了真实截图需求。


📊 文档更新详情 ​

1. 一、创建项目 (create-project.md) ​

状态: ✅ 之前已更新

插入的 SVG:

  • create-project-flow.svg - 项目创建3步流程图
  • project-list-ui.svg - 项目列表界面线框图

截图标注:

  • 项目列表页面完整截图

2. 二、创建任务 (create-task.md) ​

状态: ✅ 本次更新

主要修改:

  • 标题从 "02. 任务创建与管理" 改为 "二、创建任务"
  • 插入 create-task-flow.svg 任务创建流程图
  • 添加截图标注(任务列表页面)
  • 更新"下一步"链接

插入的 SVG:

  • create-task-flow.svg - 任务创建流程+表单示意

截图标注:

  • 项目选择器
  • 搜索框和筛选条件
  • "新增任务"按钮
  • 任务数据表格
  • 操作列

3. 三、普通工时填报 (hour-fill.md) ​

状态: ✅ 本次更新

主要修改:

  • 插入 hour-fill-flow.svg 工时填报流程对比图
  • 添加截图标注(工时填报页面)

插入的 SVG:

  • hour-fill-flow.svg - 普通工时 vs 任务工时流程对比

截图标注:

  • 日历视图或列表视图
  • 工时类型选择
  • 填报表单
  • 提交按钮

4. 四、任务工时填报 (task-hour-fill.md) ​

状态: ✅ 本次更新

主要修改:

  • 插入 task-hour-fill-flow.svg 任务工时填报详细流程
  • 添加截图标注(任务工时填报页面)

插入的 SVG:

  • task-hour-fill-flow.svg - 5步填报流程+工作类型说明

截图标注:

  • 项目选择器
  • 任务下拉列表
  • 工作类型选择
  • 工时数输入框
  • 提交按钮

5. 五、我的周报/月报 (weekly-monthly-report.md) ​

状态: ✅ 本次更新

主要修改:

  • 标题从 "我的周报/月报" 改为 "五、我的周报/月报"
  • 插入 weekly-report-cards.svg 周报统计卡片示意图
  • 添加截图标注(我的周报页面)
  • 更新"下一步"链接

插入的 SVG:

  • weekly-report-cards.svg - 4个统计信息卡片

截图标注:

  • 时间范围选择器
  • 工时类型筛选
  • 4个统计信息卡片
  • 任务工时区块(含展开功能)
  • 普通工时区块

6. 六、工时审核 (hour-review.md) ​

状态: ✅ 本次更新

主要修改:

  • 标题从 "工时审核" 改为 "六、工时审核"
  • 插入 hour-review-flow.svg 工时审核流程示意图
  • 添加截图标注(工时审核页面)
  • 更新"下一步"链接

插入的 SVG:

  • hour-review-flow.svg - 三栏审核流程(待审核→审核操作→已审核)

截图标注:

  • 待审核工时列表
  • 审核操作区域
  • 已审核工时列表
  • 批量审核功能

7. 七、数据统计 (data-statistics.md) ​

状态: ✅ 本次更新

主要修改:

  • 标题从 "数据统计" 改为 "七、数据统计"
  • 插入 data-statistics-overview.svg 数据统计功能概览
  • 添加截图标注(数据统计页面)
  • 更新"下一步"链接

插入的 SVG:

  • data-statistics-overview.svg - 统计维度+柱状图+饼图

截图标注:

  • 统计维度选择
  • 时间范围筛选器
  • 图表展示区域
  • 数据导出按钮

📁 文件清单 ​

SVG 文件(8张) ​

docs/public/images/guide/
├── create-project-flow.svg      ✅ 项目创建流程
├── project-list-ui.svg          ✅ 项目列表界面
├── create-task-flow.svg         ✅ 任务创建流程
├── hour-fill-flow.svg           ✅ 工时填报流程对比
├── task-hour-fill-flow.svg      ✅ 任务工时填报流程
├── weekly-report-cards.svg      ✅ 周报统计卡片
├── hour-review-flow.svg         ✅ 工时审核流程
└── data-statistics-overview.svg ✅ 数据统计概览

Markdown 文档(7个) ​

docs/mulin/
├── create-project.md            ✅ 已插入SVG
├── create-task.md               ✅ 已插入SVG
├── hour-fill.md                 ✅ 已插入SVG
├── task-hour-fill.md            ✅ 已插入SVG
├── weekly-monthly-report.md     ✅ 已插入SVG
├── hour-review.md               ✅ 已插入SVG
└── data-statistics.md           ✅ 已插入SVG

🎯 文档结构优化 ​

统一标题格式 ​

所有文档标题已统一为中文数字格式:

  • 一、创建项目
  • 二、创建任务
  • 三、普通工时填报
  • 四、任务工时填报
  • 五、我的周报/月报
  • 六、工时审核
  • 七、数据统计

统一"下一步"链接 ​

所有文档的"下一步"部分已更新,确保链接到正确的文档,形成完整的导航闭环。


📸 截图需求汇总 ​

需要截取的界面(共7张) ​

序号页面文件名关键内容
1项目列表project-list.png搜索框、新增按钮、数据表格、操作列
2任务列表task-list.png项目选择器、搜索框、新增按钮、任务表格
3工时填报hour-fill.png日历/列表视图、类型选择、填报表单
4任务工时填报task-hour-fill.png项目选择、任务选择、工作类型、工时输入
5我的周报weekly-report.png时间选择、类型筛选、统计卡片、工时区块
6工时审核hour-review.png待审核列表、审核操作、已审核列表
7数据统计data-statistics.png维度选择、筛选器、图表展示、导出按钮

🎨 文档增强效果 ​

1. 视觉增强 ​

  • 每个章节都有对应的流程图或界面示意图
  • SVG 示意图清晰展示操作流程和界面布局
  • 统一的设计风格,提升文档专业度

2. 内容增强 ​

  • 流程说明更加直观
  • 表单字段一目了然
  • 操作步骤清晰明确

3. 导航增强 ​

  • 统一的标题格式
  • 完整的下一步链接
  • 形成闭环的文档导航

📋 后续工作建议 ​

选项1:预览效果 ​

启动 VitePress 查看文档效果:

bash
cd docs
npm run docs:dev

选项2:截取真实界面 ​

根据截图清单,截取7张真实界面图,替换或补充 SVG 示意图

选项3:优化文档内容 ​

根据实际使用情况,进一步优化文档描述和示例

选项4:创建更多辅助文档 ​

  • 快速入门指南
  • 常见问题 FAQ
  • 最佳实践总结

✨ 完成状态 ​

任务状态说明
创建 SVG 示意图✅ 完成8张SVG全部完成
插入 SVG 到文档✅ 完成7个文档全部更新
标注截图需求✅ 完成每个文档都有明确标注
统一标题格式✅ 完成使用中文数字
更新导航链接✅ 完成形成完整闭环
真实截图收集⏳ 待进行需要用户操作
文档预览测试⏳ 待进行启动VitePress查看

🎉 总结 ​

选项2(将 SVG 插入文档)已全部完成!

现在所有使用指南章节都包含:

  • ✅ 清晰的 SVG 流程图/示意图
  • ✅ 明确的真实截图需求标注
  • ✅ 统一的标题格式
  • ✅ 完整的导航链接

文档已经具备很好的可读性和指导性,后续只需补充真实截图即可达到最佳效果!

Released under the MIT License.