缺陷截图标注示例的核心,是在截图上用编号、箭头、框选和简短文字,把“问题出现在哪里、期望是什么、实际是什么”标清楚,并在缺陷记录里用编号逐条对应说明。下面给出一份完整的假设示例(登录页验证码报错),逐项解释标注位置、文字写法和字段填写,再总结可迁移到其他缺陷场景的规律与适用边界。示例仅用于演示写法,不代表真实客户案例或实测结果。
要点总览(TL;DR)
- 缺陷截图标注示例的核心要素:编号、框选、箭头、简短文字说明,以及缺陷记录中与编号一一对应的字段内容。
- 推荐顺序:先框选问题位置,再写现象短句,最后在记录字段中补齐环境、复现步骤、期望与实际结果。
- 标注文字用“动词+对象+现象”的短句,一图一问题,多问题分图,编号在截图、说明、字段三处保持一致。
- 示例为假设情景(登录页验证码报错),换到列表页、表单页、移动端时按界面类型调整标注重点即可套用。
- 标注服务于记录质量,不承担严重程度判定;敏感信息先遮挡,时序与性能问题改用录屏或日志补充。
示例目标:这份标注要解决什么问题
这份示例要演示的,是一张缺陷截图在提交时应当承载哪些信息,才能让开发在不追问的情况下完成定位、复现和判断。为了让示例具体可读,设定一个假设情景:某后台管理系统的登录页,用户输入正确的账号密码和验证码后,点击登录,页面提示“验证码错误”,但验证码输入框中的字符与图片显示一致。该情景为演示用假设,不指向任何真实系统或客户。
围绕这个情景,标注要达成三个目标:
- 定位:让开发一眼看到问题出现在页面的哪个区域、哪个控件上,减少“你说的报错在哪里”的来回确认。
- 复现:让开发知道在什么环境、什么操作顺序下能再次触发,避免只看到结果却无法重现。
- 判断:让开发对照期望结果与实际结果,判断这是前端校验、接口返回还是验证码服务的问题,从而决定排查方向。
三个目标分别对应截图上的位置标注、记录中的复现信息、以及期望与实际结果的对照。示例的写法围绕这三件事展开,不涉及缺陷严重程度或优先级的判定,那属于缺陷分类与分级主题的内容。
完整示例:一张缺陷截图与配套记录
下面给出完整的已填写范例。截图部分用文字描述标注方案(实际提交时是在图片上绘制),记录部分给出各字段的填写内容,两者通过编号一一对应。
截图标注方案
截图内容为登录页全屏,页面中部是登录表单,包含账号、密码、验证码输入框和登录按钮。标注方案如下:
- ①红框:框住验证码输入框与验证码图片区域,框线用红色,线宽适中,不遮挡输入框内的字符。
- ②红色箭头:从页面右上角的错误提示条指向验证码输入框,箭头起点在提示条,终点在输入框上沿。
- ③黄色框:框住登录按钮,用于说明点击动作发生的位置。
- 文字说明:在截图右侧空白处写三行短句,与编号对应——“①输入与图片一致的验证码”“②点击登录后提示验证码错误”“③按钮可正常点击,无置灰”。
配套缺陷记录字段
| 字段 | 填写内容 |
|---|---|
| 标题 | 登录页输入正确验证码后提示“验证码错误”,无法登录 |
| 环境 | 测试环境;Chrome 120;Windows 11;账号为测试账号 test_user |
| 复现步骤 | 1. 打开登录页;2. 输入测试账号与正确密码;3. 按图片输入验证码;4. 点击登录按钮 |
| 期望结果 | 校验通过,进入系统首页 |
| 实际结果 | 页面顶部提示“验证码错误”,停留在登录页,验证码图片未刷新 |
| 附件说明 | 截图1:登录页标注图,①验证码输入区、②错误提示、③登录按钮;日志片段见附件2 |
这份记录中,截图编号①对应复现步骤第3步,②对应实际结果中的提示内容,③对应复现步骤第4步。开发阅读时可以先看截图定位,再按编号回到字段中核对条件,不需要额外询问。
逐项解释:每个标注和字段为什么这样写
下面逐项拆解示例中的标注元素和记录字段,说明写法依据与常见改法。
| 标注元素/字段 | 写法 | 理由 | 常见错误 |
|---|---|---|---|
| 编号与框选 | ①框住验证码输入区,编号放在框的左上角外侧 | 编号让截图与文字说明建立索引,框选把注意力收窄到具体控件,减少“页面这么大,问题在哪”的歧义 | 框选范围过大盖住整个表单;编号压在控件文字上导致看不清 |
| 箭头与文字 | “点击登录后提示验证码错误”,动词+对象+现象 | 短句说明动作与结果,开发能直接对应到复现步骤;箭头指示提示条与输入框的关联 | 在截图上写长段描述;只写“报错”不写报错内容 |
| 标题 | “输入正确验证码后提示验证码错误,无法登录” | 标题包含触发条件、现象和影响,便于在缺陷列表中快速筛选 | 标题只写“登录有问题”,缺少条件和现象 |
| 复现步骤 | 四步,每步一个动作,按操作顺序排列 | 步骤可被他人照做,是复现的前提;步骤编号与截图编号可交叉引用 | 把多个动作挤在一行;省略前置条件如账号状态 |
| 期望结果与实际结果 | 期望写“校验通过进入首页”,实际写“提示验证码错误并停留” | 两者对照能直接暴露差异点,帮助判断是校验逻辑还是提示文案问题 | 期望结果写成“应该正常”,实际结果只写“不行” |
| 附件命名与编号 | “截图1:登录页标注图”,说明中列出①②③对应内容 | 附件多时按编号命名,阅读顺序与正文说明一致,避免附件与描述脱节 | 附件命名为“截图”“新建图片”,与正文编号对不上 |
这些写法的共同点是:每个标注和字段都承担一个明确的回答任务,编号负责索引,框选负责定位,短句负责说明现象,字段负责补齐条件和对照。任何一项缺失,都会让开发多问一句。
可迁移规律:换一个缺陷场景怎么套用
从上面的示例可以提炼出几条可复用的规律,换到其他缺陷场景时按同样顺序操作即可。
- 先框位置,再写现象:先在截图上确定问题发生的控件或区域并框选,再写该位置发生了什么。顺序反过来容易写成泛泛的描述。
- 一图一问题,多问题分图:一张截图只标注一个缺陷。如果同一页面存在两个独立问题,分成两张图分别编号,避免编号交叉导致说明混乱。
- 编号—说明—字段三处对齐:截图上的编号、截图旁的短句说明、记录字段中的对应描述,三处使用同一套编号,形成可追溯的对应关系。
- 按界面类型调整标注重点:列表页重点框选异常行和列头,说明是哪一列数据不对;表单页重点框选具体输入项和校验提示;移动端截图注意标注手势操作位置和弹层遮挡关系。
以列表页场景简要套用:假设订单列表某行金额显示为负数。截图上用①框住该行金额单元格,②箭头指向列头“订单金额”,文字写“①该行金额显示为-100”“②列头为订单金额,其余行正常”。记录中标题写“订单列表金额列出现负值”,复现步骤写筛选条件与翻页位置,期望结果写“金额显示为正数或按规则显示退款标识”,实际结果写“显示-100且无退款标识”。编号与字段同样一一对应。
适用边界:标注做到什么程度就够了
标注的目的是提升缺陷记录的可读性和可复现性,做到开发能定位、能复现、能判断即可,不必追求截图的美观或标注的密度。
- 标注不承担分级判定:截图和标注说明的是“发生了什么”,严重程度和优先级由团队按影响范围、业务场景等标准另行判定,不在截图上写“严重”“紧急”之类的结论。
- 敏感信息先遮挡:截图中出现账号、手机号、内部地址、客户名称等信息时,先做遮挡或替换再上传,遮挡区域不影响问题定位。
- 截图表达不了的问题换证据:时序问题、性能问题、偶现问题,单张截图难以说明过程,应补充录屏、日志片段或时间线说明,截图只作为辅助。
- 按团队规范调整粒度:不同团队对必填字段、标注详细程度的要求不同,示例中的字段和标注数量可按团队规范增减,核心是保持编号与说明的对应关系。
当缺陷记录需要进入团队的工作流流转时,截图附件和字段内容会随缺陷工作项一起传递。ONES Project 支持一键提交 Bug 至对应项目或迭代,并记录和跟踪缺陷修复情况;ONES TestCase 中未通过的用例可快速创建缺陷任务,缺陷任务在测试与研发团队间流转。把上面这套编号与字段对应的写法用在提交环节,附件说明和复现步骤会随工作项保留,后续排查和回归时可以直接对照,减少重复沟通。
常见问题
截图上的编号和缺陷记录里的复现步骤,需要严格一一对应吗?
建议保持对应,但不必机械到每个步骤都配一个编号。可行的做法是:截图编号指向问题发生的位置和关键现象,复现步骤按操作顺序完整列出,两者在关键动作上交叉引用。例如示例中截图①对应复现步骤第3步(输入验证码),截图②对应实际结果中的提示内容。这样开发看截图能定位,看步骤能照做,两处信息互相印证。如果编号和步骤完全脱节,阅读者需要自己建立映射,反而增加理解成本。
同一页面有多个问题,是标在一张图上还是分开截图?
建议一图一问题,多问题分图。一张截图标注多个问题,编号容易交叉,文字说明也会挤在一起,开发在核对时难以判断哪个说明对应哪个位置。分开截图后,每张图只保留一个编号序列,配套记录中分别描述各自的复现步骤和期望结果。如果多个问题确实出现在同一操作路径上,可以在记录中说明它们的关系,但截图仍建议分开,避免标注互相遮挡。
截图里包含账号、手机号等敏感信息,标注时怎么处理?
先遮挡或替换,再上传。遮挡区域应避开问题定位所需的关键控件和提示文字,例如把账号中间几位打码,保留输入框位置和报错提示的可见性。如果敏感信息恰好是问题本身(如脱敏规则错误),可以用测试账号复现后截图,并在记录中说明使用的是测试数据。遮挡处理不影响标注编号和说明的对应关系,编号仍指向未遮挡的问题区域。
偶现问题或性能问题,截图标注还能用吗?
截图可以作为辅助证据,但难以单独说明过程。偶现问题需要补充触发次数、时间点、操作路径和日志片段;性能问题需要补充响应时间、操作步骤和监控数据。截图此时的作用是标明问题发生的界面位置和当时的提示状态,与录屏、日志一起构成证据链。记录中应说明截图对应的是哪一次复现,避免开发误以为截图能代表全部现象。
团队对缺陷字段的必填要求不同,示例里的字段可以增减吗?
可以。示例中的标题、环境、复现步骤、期望结果、实际结果、附件说明是常见字段组合,不同团队可能要求额外填写模块、版本号、关联需求等,也可能允许部分字段选填。调整时保持一个原则:截图编号、截图旁说明、记录字段三处使用同一套编号和描述,增减字段不破坏这个对应关系。团队规范差异属于正常情况,示例提供的是写法结构,具体字段以团队模板为准。
