sakura1412/skill

codex skill

★ 0Forks 0GitHub ↗Compare

README

标注(Biaozhu)

一个根据 PRD 与原型/设计稿进行页面标注的 Codex Skill,通过插件形式分发。

提供资料后,Codex 按规范提取需求、匹配页面和控件,在原页面或原始画面上制作编号气泡。点击气泡,在右侧查看和编辑内容、功能、限制、跳转及具体依据。

2.0 版的核心原则:AI 负责提取和比对,不凭界面、历史印象或常见产品规则补写需求。资料没有写清楚的内容,应当展示缺口,而不是给出看似确定的解释。

本仓库包含 Skill 指令、参考规范和插件配置,不包含现成的标注前端、浏览器扩展或托管服务。安装后,需要在任务中提供资料并调用 Skill,由 Codex 为指定项目实现或更新标注。

安装

方式一:安装插件

在已安装 Codex CLI 的环境中执行:

codex plugin marketplace add sakura1412/skill --ref main

重启桌面客户端,在插件目录(Plugins Directory)中选择 Sakura1412 Skills,安装 标注。添加市场不等于已经安装插件。客户端入口以实际版本为准;命令或入口不可用时,可以使用下面的独立 Skill 方式。

市场添加、刷新和桌面安装流程参考 OpenAI 官方插件文档。本仓库市场标识为 sakura1412-skills,插件标识为 biaozhu。

方式二:只安装 Skill

如果你的 Codex 提供内置 skill-installer,在任务中输入:

使用 $skill-installer 从以下地址安装标注 Skill:
https://github.com/sakura1412/skill/tree/main/plugins/biaozhu/skills/biaozhu
如果已有同名 Skill,请先说明如何保留本地自定义修改,不要直接覆盖。

完成后按安装器提示重新加载,确认技能列表中出现“标注”。两种方式选择一种即可,避免同时保留不同版本的同名技能。

开始前准备什么

需要提供两类资料,并确保当前 Codex 任务有能力和权限读取它们:

资料 可提供的形式 用途
PRD 文档文件、可读链接、粘贴文字或 PRD 页面截图 定义页面内容、功能、限制和跳转
原型/设计稿 页面或画板链接、原型文件、导出图片/截图 定位页面、标签、状态及具体控件
补充信息(可选) 版本、标注范围、目标项目、已有标注、明确修订 确定资料基线,保护编号和人工编辑

PRD 截图可以作为输入,不强制另交文字版;数字、单位、连线等需要能看清。链接需要登录或无法读取时,可提供有权分享的页面导出。不要发送账号密码或访问令牌。

默认范围是所给资料中本期相关的全部页面、标签和状态,不是链接所在的整个工作区。缺一类资料时可以先整理已有信息,但不能宣称完成了 PRD 与设计的联合标注。

快速使用

在需要标注的项目或任务中附上资料,把下面的占位内容替换成实际信息:

使用 $biaozhu。

PRD:[上传的文件、文档地址或 PRD 截图]
原型/设计稿:[可访问的地址或导出文件]
资料版本:[版本号;不知道则写未标明]
标注范围:[本期相关全部页面,或指定页面及标签]
目标项目:[当前项目;没有源码则制作原图标注预览]

请对照资料进行标注,沿用编号气泡和右侧可编辑详情。
每个已定位的可见按钮、输入框、选择器等控件独立编号。
说明内容、功能、限制和跳转,并注明具体出处。
缺失、冲突和对应不确定的信息单独列出,不自行补齐。
切换标签后,只显示公共区域和当前标签的标注。

已经在当前任务中提供的资料无需重复提交。显示名称是“标注”,调用标识是 $biaozhu。

修改某条标注

可以直接在生成的右侧详情栏编辑并保存,也可以按编号提出修改。例如:

使用 $biaozhu,修改 A-012 的功能说明为:[准确的新说明]。
记录为我对本次版本的明确修订,保留编号、原始依据和修改记录。

PRD 或设计更新后重新标注

使用 $biaozhu。
新版 PRD:[文件或地址]
新版设计稿:[地址或导出文件]
这两份资料替代上次的 [版本号]。
仅更新受影响的标注,保留已有编号和人工编辑。
旧锚点或说明无法验证时标为待复核,不直接覆盖。

标注如何展示

Skill 要求具体项目的标注实现遵守以下交互规则:

  • 气泡叠加在原页面/原画面上,显示 A-001 式稳定编号,靠近对应控件,不遮挡主要操作区域。
  • 每个已定位的可见交互控件独立标注;未提供的弹窗、下拉选项或错误态列为缺口,不凭经验补出。
  • 点击多个气泡,可在右侧同时查看多条详情;详情包含内容或功能、限制、跳转、各字段依据和待确认项。
  • 详情可以编辑和保存。关闭某条详情或清空右侧列表只改变展示,不删除标注。
  • 切换标签后,气泡、连接线和已打开详情都只属于当前活动标签及其公共区域;不同标签的打开状态和草稿分别保存。
  • 标注层不能阻挡原页面的点击、输入和标签切换;关闭标注模式后应恢复原有交互。窄屏可使用可收起的右侧抽屉。

这些是执行和验收要求,不代表安装插件后所有网站就自动具备上述界面。

根据目标条件选择呈现方式

目标条件 交付方式 边界
有可编辑项目或原型 在用户指定目标上接入标注层 保留原布局和业务操作;修改第三方原稿需授权
只有只读设计或图片 基于实际原图制作本地交互标注预览 可以查看、切换画面、缩放及编辑标注;原图中的表单不是可操作业务表单
可访问在线原型 使用现有读取能力;工具支持且获授权时使用覆盖层 不承诺跨域注入或永久修改远端;受限时使用原始导出

仅生成一份说明文档不算完成页面标注。资料清单、对应关系和问题记录是辅助交付物。

如何避免“AI 自行理解”

每项具体说法都应对应实际读过的 PRD 章节、截图区域、设计节点、原型连接或用户明确修订。只写“来自 PRD”或提供整份文档链接不够。

内容、功能、限制、跳转分别记录状态,一条标注可以同时存在已知信息和缺口:

状态 含义
有依据 PRD 或明确修订直接支持,当前资料不存在冲突
设计可见 设计中的可见文字、状态或明确原型交互,不代表生产功能已实现
未说明 已检查资料没有定义,不能改写成“无限制”或“无跳转”
冲突待确认 资料说法不一致,保留各方说明和具体出处
待复核 来源换版、截图模糊或旧对应关系不再可靠

例如(虚构示例):PRD 写“名称最多 20 个字符”,设计稿写“最多 30 个字符”,应在该字段的限制说明中并列展示两种说法和出处,标为冲突;不能擅自选 20 或 30。设计上的星号只能证明显示了必填标记,不能证明系统真的会拦截空值。

目标控件已找到,也不代表它的业务说明已确认。同名按钮无法唯一关联需求时,应保留候选,不随意贴标。普通历史聊天只作为查找线索,不自动替代本次 PRD。

保存、更新与交付

保存方式由目标项目决定:优先复用已有标注数据层;没有后端时,可采用项目标注配置加浏览器本地覆盖数据。交付时必须写清保存位置和范围。浏览器本地修改通常仅当前浏览器/设备有效,不等于修改了 Git 仓库、远端设计稿或完成了跨设备同步。

编号不会因刷新、排序或新增控件而重排。人工编辑保留原证据和修订记录;仅保存新文字不等于解决了资料冲突。资料换版后重核受影响项,不能抹掉人工内容;暂时无法访问或匹配的控件也不能直接算作已删除。

一次标注任务应交付:

  • 页面标注入口或项目接入位置,以及标注开关的使用方法。
  • 实际读取的资料及版本、页面/状态覆盖和未访问范围。
  • 已定位控件、证据充分的说明、用户已确认项的分别统计。
  • 冲突、缺失、待定位及待复核项。
  • 保存范围,实际完成的交互和证据检查,以及未验证的原因。

验收重点包括多气泡展开、编辑保存后刷新、逐个及快速切换标签、滚动缩放、窄屏和关闭标注后的原页面交互。真实生产提交、删除、付款和部署不属于标注任务的默认授权。

更新已安装版本

通过插件市场安装时,可先刷新本市场:

codex plugin marketplace upgrade sakura1412-skills

刷新命令参考 OpenAI 官方插件文档。随后在客户端检查插件版本与启用状态,并按客户端提示重新加载或更新。仓库推送成功不等于每个使用者的已安装副本都已更新。

独立 Skill 的使用者,可让 skill-installer 检查同一来源的新版并说明更新方式;更新前备份自定义修改。升级 Skill 指令不会自动重做业务项目的已有标注,需要在项目任务中再次调用。

仓库结构与规范

.
├── README.md
├── .agents/plugins/marketplace.json
└── plugins/biaozhu/
    ├── .codex-plugin/plugin.json
    └── skills/biaozhu/
        ├── SKILL.md
        ├── agents/openai.yaml
        └── references/
            ├── evidence-and-mapping.md
            └── display-and-verification.md

当前验证范围

2.0 版已完成 Skill 与插件结构校验,以及缺失、冲突、版本变化和人工修订的离线案例检查。本仓库没有通用标注运行时或真实项目的端到端测试;实际效果仍需在具体任务中按展示规范验证,不能用结构校验代替页面交互验收。

隐私与访问边界

本仓库不需要包含客户 PRD、私有设计稿、标注业务数据、密码或令牌。实际资料只应在获授权的任务和目标环境中使用,不要将客户输入随 Skill 一起提交到公开仓库。读取链接、登录服务或写入第三方设计工具的能力,取决于用户环境中的工具、连接和权限;安装本 Skill 不会自动获得这些权限。

Contributors

sakura1412

Issues