Notes 验证地图
Notes 验证地图
Section titled “Notes 验证地图”这个目录是验证 Notes 面向用户行为时持续维护的依据。操作应用之前先读这份索引，再把对应的功能文件当作操作步骤来用。
- 在
http://127.0.0.1:4173启动 Notes，用一个用完即弃的数据目录。 - 设置
NOTES_DATA_DIR=/tmp/notes-verify-$RUN_ID，让同时进行的几次运行不共享状态。 - 预先放入标题为
Quarterly plan和Grocery list的笔记。 - 把
control-notes和notesCLI 加进PATH。 - 运行
control-notes doctor，要求 URL、数据目录和构建版本都符合预期。 - 不是这次验证运行启动的实例，绝不去操作。
- 每份步骤都从基础状态开始，除非它的前提另有说明。
- 优先用 ARIA 角色和无障碍名称，不用 CSS 选择器或 DOM 位置。
- 每条命令都照字面执行。引号里的名称和参数原样保留。
- 浏览器操作通过
control-notes browser来跑。 - 终端操作通过
control-notes cli -- <command>来跑。 - 改动数据之后，把预置数据恢复原样。清理时不要删掉证明材料。
证明和跳过的报告方式
Section titled “证明和跳过的报告方式”- 记录用户的操作和操作后的状态，不只是最后一屏。
- UI 的证明包括一份 ARIA 快照，和一张能看出是哪个应用的截图。
- CLI 的证明包括命令、stdout、stderr 和退出码。
- 改动数据的证明要包括从另一个只读视图再看一次存下来的值。
- 每份证明材料都记下功能 ID 和用了哪个入口。
- 走不通的路径，报告尝试过的命令和没满足的前提。
- 跳过的入口不要说成已经通过另一条路径验证过。
每个功能文件怎么写
Section titled “每个功能文件怎么写”每个功能文件以一个一级标题开头，接一段话描述用户能看到的行为。之后按下面的顺序，正好用四个二级标题。
Sub-features列出简短的 ID，每个行为一行。How to get to it (user POV)列出用户的每一个入口。Driving it with <harness>以Preconditions:开头，用带标签的列表项，把每个用户操作和确切的命令、可观察的结果配成一对。Gotchas列出会浪费一次验证运行或让它作废的陷阱。
地图里不写实现细节。只写用户路径、稳定的抓手、需要的状态、命令和可观察的证明。