用途:为 packages/ui/src/lib/* 下的 UI 原语模块(如 popover、press 等)撰写或修订模块级 README,目标是让智能体和开发者快速、正确地采用该原语。注意这是模块文档,不是包级 README。
主要能力与流程:先阅读模块源码,确认实际公开导出及其职责,行为以代码为准而非记忆;再阅读邻近测试与示例,从测试中提取行为说明,示例优先复用最贴近真实场景的写法;只记录模块当前状态,不描述计划中的 API,不写内部协调器、私有状态或历史变通方案,除非它们属于公开契约。
推荐结构:# ModuleName(一两句说明是什么、用于什么、不用于什么)、## Usage、导出引用(如 module.*)、## Behavior Notes,以及在原语位于更高层组件之下时的 ## When To Use Something Else。
用法要点:Usage 以可复制粘贴的示例开头,展示真实调用形态,使用实际导出名,给出正确使用所需的最小外围结构,并展示与其他一方 UI 辅助工具的组合;弹层类原语示例通常包含触发器、surface/root、一两个有意义的控件以及关闭或完成路径。导出引用部分用几行说明每个重要导出的作用、应用位置、关键参数与可观察行为,不做完整 API 罗列。Behavior Notes 记录组合时重要的行为,如焦点移动、关闭规则、锚定规则、键盘行为、多触发器行为及测试覆盖的保证。
限制:不写私有类、内部协调器或辅助 mixin(除非 README 专为该辅助工具而写),不堆砌通用无障碍或弹层理论,不记录实现历史与内部类型走查。资料未提供具体模块的导出清单与示例代码,实际撰写时需以对应模块源码、测试和示例为准。