RWork 软件工程文档集
按软件工程阶段分目录。每个阶段一个文件夹;每个文档的附件放在同级的
<文档名>-images/(图片、截图、示意图)与 <文档名>-files/(原始数据、脚本、清单)里。
| 阶段目录 | 文档 | 内容 |
|---|---|---|
01-架构设计/ |
架构设计文档 | 系统定位与约束、crate 划分、运行时视图、关键数据流、10 条架构决策记录(ADR)、质量属性、已知取舍 |
02-功能需求/ |
功能需求文档 | 范围与非目标、用户场景、13 组功能需求(带验收标准与验证方式)、非功能需求、需求追踪矩阵、未实现缺口 |
03-概要设计/ |
概要设计文档 | 模块划分与依赖、数据模型(表结构)、跨 crate 接口清单、四条关键流程、配置与迁移、错误处理 |
04-详细设计/ |
详细设计文档 | 逐模块的数据结构、关键函数签名与算法步骤、不变量与失败路径 |
05-单元测试设计/ |
单元测试设计文档 | 测试策略与取舍、分层结构、按 crate 的用例表、夹具、覆盖矩阵 |
06-端到端测试设计/ |
端到端测试设计文档 | 真实依赖边界、脚本化服务器设计、会话级界面测试、忽略策略、场景与判据清单 |
07-单元测试结果/ |
单元测试结果报告 | 环境、命令、逐 crate 结果(976 通过 / 0 失败 / 1 忽略)、一条已定位并修掉的偶发失败 |
08-端到端测试结果/ |
端到端测试结果报告 | 逐套件结果(42 通过)、界面渲染测试、三条真机测试的真实输出、界面截图、未覆盖项 |
09-后续任务清单/ |
后续任务清单 | 36 项待办(已完成 13 项),含仓库自己的 [未做]/[部分],带依据与验收标准;附件 CSV 可直接导入任务板 |
10-实验性质功能/ |
实验性质功能 | 尚未定案的设计(不是已承诺的需求)。当前三份:记忆系统与本地小模型、片段级组合泛化 Agent 完整设计、本机裁决模型调研与设计 |
10与其余九个不是同类:它们描述已经实现并验证过的行为,而10只描述提案。 引用10里的话时必须写明「实验性质」。两者的转换规则见10-实验性质功能/README.md。
阅读顺序建议
- 先看 02 功能需求 知道它做什么、不做什么;
- 再看 01 架构设计 知道为什么这样分层、有哪些硬约束与取舍;
- 要改代码,直接看 04 详细设计;
- 要动测试,看 05 / 06;
- 07 / 08 是当前质量状态的证据,全部数字都能在各自的附件里逐行核对。
关于证据
这套文档里的每条技术断言都指向真实的源码位置或真实的运行输出:
- 设计类断言给出
路径:行号; - 测试结果给出附件里的原始输出文件(
cargo test的完整 stdout); - 截图是真机截图,由
08-端到端测试结果/端到端测试结果报告-files/capture-window.ps1抓取, 且只抓 RWork 自己的窗口矩形(不抓整个桌面); - 拿不准的地方写「未验证」或「未覆盖」,不含推测性结论。