docs(readme): 优化文档结构,移除重复内容
- 移除 README.md 重复的"最新更新"内容(约137行) - 建立文档单一真实来源:CHANGELOG.md 为版本历史权威来源 - README.md 新增简洁"近期亮点"部分 - 更新 docs/README.md 添加测试策略文档引用 - 更新架构图视图位置 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Showing
4 changed files
with
34 additions
and
139 deletions
| ... | @@ -49,143 +49,17 @@ pnpm lint | ... | @@ -49,143 +49,17 @@ pnpm lint |
| 49 | - ✅ **文档预览能力** - DocumentPreview 支持多格式文件预览 | 49 | - ✅ **文档预览能力** - DocumentPreview 支持多格式文件预览 |
| 50 | - ✅ **统一列表交互** - 搜索、收藏、资料列表统一点击与操作逻辑 | 50 | - ✅ **统一列表交互** - 搜索、收藏、资料列表统一点击与操作逻辑 |
| 51 | 51 | ||
| 52 | -## 🆕 最新更新(2026-02-15 & 2026-02-14) | 52 | +## 📝 更新日志 |
| 53 | - | ||
| 54 | -### 文档解析重大升级(2026-02-15) | ||
| 55 | -- ✅ **多产品文档解析** - 支持自动识别和分割包含多个保险产品的文档 | ||
| 56 | -- ✅ **智能字段提取器** - 实现 smartExtractList() 智能列表边界识别 | ||
| 57 | -- ✅ **产品边界检测** - 支持产品代码(GS、GC、FA、LV2)和命名模式识别 | ||
| 58 | -- ✅ **MCP 解析切换** - 完善 markitdown 文档解析服务集成 | ||
| 59 | -- ✅ **审核流程落地** - 待审核文件管理,人工确认后才写入配置 | ||
| 60 | - | ||
| 61 | -### Git 工作流优化(2026-02-14) | ||
| 62 | -- ✅ **版本管理标准化** - 使用 standard-version 替代自定义脚本 | ||
| 63 | -- ✅ **Conventional Commits** - 配置提交信息规范 | ||
| 64 | -- ✅ **自动化版本发布** - 自动更新版本号和生成 Git 标签 | ||
| 65 | -- ✅ **人工维护 CHANGELOG** - 配置跳过自动生成,使用自定义模板 | ||
| 66 | - | ||
| 67 | -### 消息功能全面优化(2026-02-14) | ||
| 68 | -- ✅ **列表布局优化** - 提升消息卡片信息可读性 | ||
| 69 | -- ✅ **代码简化** - 移除冗余逻辑,提升可维护性 | ||
| 70 | -- ✅ **详情页优化** - 避免内容重复显示,统一交互体验 | ||
| 71 | - | ||
| 72 | -### 计划书模块重构(2026-02-14) | ||
| 73 | -- ✅ **Schema 驱动** - 储蓄类/人寿/重疾模板字段配置化 | ||
| 74 | -- ✅ **提交映射优化** - 从容器迁移到模板配置 | ||
| 75 | -- ✅ **校验提示改进** - 必填提示与百分比校验统一 | ||
| 76 | - | ||
| 77 | -### 构建告警修复(2026-02-14) | ||
| 78 | -- ✅ **usePlanView 导出补齐** - 补充 usePlanView 导出并绑定 viewFile,修复构建告警 | ||
| 79 | - | ||
| 80 | -### 计划书表单演进 | ||
| 81 | -- ✅ **Schema 驱动** - 储蓄类模板字段由配置驱动渲染与校验 | ||
| 82 | -- ✅ **提交映射下沉** - 提交字段映射从容器迁移到模板配置 | ||
| 83 | -- ✅ **人寿/重疾同步** - 人寿与重疾模板改为 Schema 驱动 | ||
| 84 | -- ✅ **校验提示优化** - 必填提示与百分比校验统一更准确 | ||
| 85 | - | ||
| 86 | -### 字段命名优化 | ||
| 87 | -- ✅ **提取方式字段** - 统一将 specified_amount_type 重命名为 withdrawal_method | ||
| 88 | -- ✅ **文档同步** - 更新提取计划相关文档字段示例 | ||
| 89 | -- ✅ **优化建议** - 提取计划相关字段命名保持“功能优先”的语义一致性 | ||
| 90 | - | ||
| 91 | -### 文档对齐 | ||
| 92 | -- ✅ **业务模块更新** - README 页面清单与业务模块对齐现有路由 | ||
| 93 | -- ✅ **新人指南更新** - 入口文档从工具生成器调整为业务上手流程 | ||
| 94 | -- ✅ **文档导航同步** - docs/README 快速导航修正与补充 | ||
| 95 | - | ||
| 96 | -### 文档解析改造 | ||
| 97 | -- ✅ **任务清单** - 输出文档解析改造任务清单,便于跟踪与回顾 | ||
| 98 | -- ✅ **文本抽取管线** - 接入 PDF/Docx 文本抽取与统一结构输出 | ||
| 99 | -- ✅ **结构化校验** - 接入 JSON Schema 校验并阻断非法配置写入 | ||
| 100 | -- ✅ **写入稳态化** - 结构化插入、重复检测与 dry-run 预览已接入 | ||
| 101 | -- ✅ **输出结构补齐** - 解析输出 JSON 结构与稳定 form_sn 规则已明确 | ||
| 102 | -- ✅ **审计与摘要** - 解析摘要与审计日志输出已接入 | ||
| 103 | -- ✅ **审核流程规划** - 整理审核流程方案并对齐字段与目录规范 | ||
| 104 | -- ✅ **审核模板落地** - 待审核文件输出完善,默认不写入配置,需显式 --write-config | ||
| 105 | -- ✅ **链路与思路** - 补充解析链路与使用思路,明确审核与合并边界 | ||
| 106 | - | ||
| 107 | -### 测试与验证 | ||
| 108 | -- ✅ **回归测试** - pnpm test 通过,pnpm lint 存在 30 个现存警告 | ||
| 109 | - | ||
| 110 | -### 计划书模块定位 | ||
| 111 | -- ✅ **配置与入口整理** - 补充计划书模块入口、配置与 API 位置说明 | ||
| 112 | -- ✅ **优化建议** - 新增产品时优先补齐 form_sn 与 plan_config,避免模板缺失 | ||
| 113 | - | ||
| 114 | -### 计划书模块优化补齐 | ||
| 115 | -- ✅ **字段分组补齐** - 补齐基本信息/保障/提取字段分组 | ||
| 116 | -- ✅ **错误回调兼容** - 支持 onError 回调并保持 onViewError 兼容 | ||
| 117 | -- ✅ **转换逻辑修正** - 分元双向转换统一使用转换器 | ||
| 118 | -- ✅ **依赖检测测试** - 补充循环依赖检测单测与分组工具测试 | ||
| 119 | - | ||
| 120 | -### 计划书配置核查 | ||
| 121 | -- ✅ **配置应用核查** - 确认 plan-templates 已驱动表单渲染与提交映射,plan-fields 与字段关联/转换 composable 尚未接入生成链路 | ||
| 122 | -- ✅ **依赖与转换接入** - 表单可见性接入 useFieldDependencies,提交金额转换接入 useFieldValueTransform | ||
| 123 | -- ✅ **提取字段拆分** - 指定提取金额与最高固定提取金额字段独立显示与提交映射 | ||
| 124 | - | ||
| 125 | -## 🆕 最新更新(2026-02-14) | ||
| 126 | - | ||
| 127 | -### 文档解析 | ||
| 128 | -- ✅ **解析验证** - 成功解析 测试计划书-智享未来.md 并生成配置 | ||
| 129 | -- ✅ **优化建议** - 解析结果需补齐 form_schema 与 submit_mapping 以便直接渲染 | ||
| 130 | -- ✅ **规则落地** - 解析生成按保险类型自动注入 form_schema 与 submit_mapping | ||
| 131 | -- ✅ **空值回退** - 空 schema 自动回退默认 schema,避免生成空表单 | ||
| 132 | -- ✅ **文件过滤** - 解析批量扫描时自动跳过 docs/to-parse/README.md | ||
| 133 | - | ||
| 134 | -### 测试与验证 | ||
| 135 | -- ✅ **测试修正** - 搜索页单测固定使用真实 API Mock,避免受全局 Mock 开关影响 | ||
| 136 | - | ||
| 137 | -## 🆕 最新更新(2026-02-13) | ||
| 138 | - | ||
| 139 | -### 权限与测试 | ||
| 140 | -- ✅ **资料查看权限** - 资料查看入口增加登录校验,支持动作级权限扩展 | ||
| 141 | -- ✅ **回跳路径统一** - 统一保存登录回跳路径,确保权限拦截后可恢复 | ||
| 142 | -- ✅ **搜索页测试** - 搜索页测试对齐当前实现并补充接口 Mock | ||
| 143 | - | ||
| 144 | -### 文档解析 | ||
| 145 | -- ✅ **配置生成修复** - 修复文档解析生成配置的 form_sn 前缀、category 位置与插入稳定性 | ||
| 146 | - | ||
| 147 | -## 🆕 最新更新(2026-02-12) | ||
| 148 | - | ||
| 149 | -### 计划书功能优化 | ||
| 150 | -- ✅ **状态标记** - 添加计划书卡片状态标记("生成中" / "已完成") | ||
| 151 | - - 黄色背景表示"生成中"状态 | ||
| 152 | - - 绿色背景表示"已完成"状态 | ||
| 153 | - - 使用条件类名动态切换样式 | ||
| 154 | -- ✅ **查看状态更新** - 仅在预览成功后标记为已查看,返回列表不刷新位置 | ||
| 155 | -- ✅ **提交跳转体验** - 提交后先关闭并重置弹框,再无固定延迟跳转结果页 | ||
| 156 | -- ✅ **返回重置体验** - 关闭弹框时清理已选产品,确保返回后表单为空 | ||
| 157 | -- ✅ **字段优化** - 优化提取金额字段并新增每年提取字段 | ||
| 158 | - | ||
| 159 | -### 认证与权限优化 | ||
| 160 | -- ✅ **登录权限检查** - 为所有制作计划书按钮添加登录权限检查 | ||
| 161 | -- ✅ **红点状态管理** - 修复退出登录时红点状态未重置的问题 | ||
| 162 | -- ✅ **TabBar 红点** - 配置 TabBar 红点功能使用新的 unread_msg_count 字段 | ||
| 163 | -- ✅ **登录页返回** - 修复登录页返回按钮,清空 router store 并跳转到首页 | ||
| 164 | -- ✅ **401 修复** - 修复 401 重定向死循环和返回报错问题 | ||
| 165 | - | ||
| 166 | -### 消息功能优化 | ||
| 167 | -- ✅ **消息列表** - 优化消息列表卡片布局,提升信息可读性 | ||
| 168 | -- ✅ **消息详情** - 优化消息详情页布局,避免内容重复显示 | ||
| 169 | -- ✅ **未读提示** - 增加未读消息红点提示 | ||
| 170 | -- ✅ **API 错误处理** - 添加消息列表 API 错误提示 | ||
| 171 | - | ||
| 172 | -### 视觉优化 | ||
| 173 | -- ✅ **首页网格导航** - 优化导航图标视觉体验 | ||
| 174 | -- ✅ **产品卡片** - 优化 ProductCard 组件视觉样式 | ||
| 175 | -- ✅ **页面风格** - 重构"我的"页面为专业高端风格 | ||
| 176 | -- ✅ **统一视觉** - 优化视觉柔和度和整体统一性 | ||
| 177 | -- ✅ **头图优化** - 优化首页头图 CDN 加载 | ||
| 178 | - | ||
| 179 | -### API 集成 | ||
| 180 | -- ✅ **接口联调完成** - 计划书模块接口联调完成(submitPlanAPI、listAPI) | ||
| 181 | -- ✅ **总进度** - 29 个接口,已完成 26 个(89.7%) | ||
| 182 | -- ✅ **关闭 Mock** - 禁用消息列表 Mock 数据,使用真实接口 | ||
| 183 | 53 | ||
| 184 | -### 代码质量 | 54 | +> **完整更新记录请查看 [CHANGELOG.md](docs/CHANGELOG.md)** |
| 185 | -- ✅ **移除本地配置** - 从版本控制中移除本地配置文件 settings.local.json | 55 | + |
| 186 | -- ✅ **Composable 抽取** - 提取计划书提交回调逻辑为 composable | 56 | +### 近期亮点 |
| 187 | -- ✅ **清理调试日志** - 清理项目中的调试日志 | 57 | + |
| 188 | -- ✅ **文档更新** - 完善开发文档和经验教训总结 | 58 | +- **多产品文档解析** - 支持自动识别和分割包含多个保险产品的文档 |
| 59 | +- **计划书 Schema 驱动** - 储蓄类/人寿/重疾模板字段配置化 | ||
| 60 | +- **Git 工作流标准化** - 使用 standard-version + Conventional Commits | ||
| 61 | +- **认证系统完善** - 401 自动刷新、登录权限检查、TabBar 红点 | ||
| 62 | +- **API 集成进度** - 29 个接口,已完成 26 个(89.7%) | ||
| 189 | 63 | ||
| 190 | ## ⚡ 常见问题 | 64 | ## ⚡ 常见问题 |
| 191 | 65 | ... | ... |
| 1 | # CHANGELOG | 1 | # CHANGELOG |
| 2 | 2 | ||
| 3 | +## [2026-02-22] - 文档结构优化 | ||
| 4 | + | ||
| 5 | +### 文档 | ||
| 6 | +- 优化 README.md 结构,移除重复的"最新更新"内容(约137行) | ||
| 7 | +- 建立文档单一真实来源:CHANGELOG.md 为版本历史权威来源 | ||
| 8 | +- README.md 新增简洁"近期亮点"部分,引导用户查看完整 CHANGELOG | ||
| 9 | + | ||
| 10 | +--- | ||
| 11 | + | ||
| 12 | +## [2026-02-22] - 测试策略文档 | ||
| 13 | + | ||
| 14 | +### 文档 | ||
| 15 | +- 新增微信小程序测试策略指南(docs/testing-strategy.md) | ||
| 16 | +- 定义测试金字塔:70% 单元测试 + 20% 集成测试 + 5% E2E 测试 + 5% 手动测试 | ||
| 17 | +- 记录现有测试基础设施:Vitest + @vue/test-utils + happy-dom | ||
| 18 | +- 制定短/中/长期测试实施路线图 | ||
| 19 | + | ||
| 20 | +--- | ||
| 21 | + | ||
| 3 | ## [2026-02-15] - 项目架构图整理 | 22 | ## [2026-02-15] - 项目架构图整理 |
| 4 | 23 | ||
| 5 | ### 文档 | 24 | ### 文档 | ... | ... |
| ... | @@ -9,6 +9,7 @@ docs/ | ... | @@ -9,6 +9,7 @@ docs/ |
| 9 | ├── CHANGELOG.md # 项目变更日志(核心文档) | 9 | ├── CHANGELOG.md # 项目变更日志(核心文档) |
| 10 | ├── README.md # 本文件(文档导航索引) | 10 | ├── README.md # 本文件(文档导航索引) |
| 11 | ├── lessons-learned.md # 经验教训总结(核心文档) | 11 | ├── lessons-learned.md # 经验教训总结(核心文档) |
| 12 | +├── testing-strategy.md # 微信小程序测试策略指南 | ||
| 12 | │ | 13 | │ |
| 13 | ├── guides/ # 📘 使用指南和教程 | 14 | ├── guides/ # 📘 使用指南和教程 |
| 14 | │ ├── 新人入门指南.md # 新人入门指南 | 15 | │ ├── 新人入门指南.md # 新人入门指南 |
| ... | @@ -84,6 +85,7 @@ docs/ | ... | @@ -84,6 +85,7 @@ docs/ |
| 84 | - 📖 [项目变更日志](CHANGELOG.md) - 所有功能、修复和优化的记录 | 85 | - 📖 [项目变更日志](CHANGELOG.md) - 所有功能、修复和优化的记录 |
| 85 | - 📖 [经验教训总结](lessons-learned.md) - 开发中的最佳实践和常见陷阱 | 86 | - 📖 [经验教训总结](lessons-learned.md) - 开发中的最佳实践和常见陷阱 |
| 86 | - 📖 [API 联调日志](api-docs/API 集成日志.md) - 接口联调状态记录 | 87 | - 📖 [API 联调日志](api-docs/API 集成日志.md) - 接口联调状态记录 |
| 88 | +- 📖 [微信小程序测试策略指南](testing-strategy.md) - 完整的测试分层策略和实施方案 | ||
| 87 | 89 | ||
| 88 | ### 新手入门 | 90 | ### 新手入门 |
| 89 | 👉 **[guides/新人入门指南.md](guides/新人入门指南.md)** - 快速了解业务与页面结构 | 91 | 👉 **[guides/新人入门指南.md](guides/新人入门指南.md)** - 快速了解业务与页面结构 |
| ... | @@ -176,4 +178,4 @@ UI/UX 设计稿和生成的代码: | ... | @@ -176,4 +178,4 @@ UI/UX 设计稿和生成的代码: |
| 176 | 178 | ||
| 177 | --- | 179 | --- |
| 178 | 180 | ||
| 179 | -**最后更新**: 2026-02-14 | 181 | +**最后更新**: 2026-02-22 | ... | ... |
| 1 | <mxfile host="65bd71144e"> | 1 | <mxfile host="65bd71144e"> |
| 2 | <diagram id="b5dOQcsEGuaq2pC0fEqS" name="第 1 页"> | 2 | <diagram id="b5dOQcsEGuaq2pC0fEqS" name="第 1 页"> |
| 3 | - <mxGraphModel dx="1990" dy="1355" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="0" pageScale="1" pageWidth="1600" pageHeight="1200" math="0" shadow="0"> | 3 | + <mxGraphModel dx="1953" dy="1355" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="0" pageScale="1" pageWidth="1600" pageHeight="1200" math="0" shadow="0"> |
| 4 | <root> | 4 | <root> |
| 5 | <mxCell id="0"/> | 5 | <mxCell id="0"/> |
| 6 | <mxCell id="1" parent="0"/> | 6 | <mxCell id="1" parent="0"/> |
| ... | @@ -147,7 +147,7 @@ | ... | @@ -147,7 +147,7 @@ |
| 147 | </mxCell> | 147 | </mxCell> |
| 148 | <mxCell id="flow-label4" value="组件复用" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];fontSize=14;fontStyle=1;fontFamily=Noto Sans JP;labelBackgroundColor=#ffffff;" parent="arrow4" vertex="1" connectable="0"> | 148 | <mxCell id="flow-label4" value="组件复用" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];fontSize=14;fontStyle=1;fontFamily=Noto Sans JP;labelBackgroundColor=#ffffff;" parent="arrow4" vertex="1" connectable="0"> |
| 149 | <mxGeometry x="-0.2" y="2" relative="1" as="geometry"> | 149 | <mxGeometry x="-0.2" y="2" relative="1" as="geometry"> |
| 150 | - <mxPoint x="-10" y="-9" as="offset"/> | 150 | + <mxPoint x="137" y="-9" as="offset"/> |
| 151 | </mxGeometry> | 151 | </mxGeometry> |
| 152 | </mxCell> | 152 | </mxCell> |
| 153 | </root> | 153 | </root> | ... | ... |
-
Please register or login to post a comment