需求清单要写到“任何人拿着它都能判断链接是否做对”的程度。具体说,每条链接需求至少应包含四件事:链接出现在哪个页面和位置、链接指向什么目标、点击后的预期结果、以及用什么标准验收。只写“加几个链接”或“链接要合理”都不够,因为开发、编辑和验收方对“合理”的理解可能完全不同。判断清单是否合格,可以用一个简单方法:把清单交给没参与讨论的人,看他能否在不提问的情况下完成并判断对错。
写需求前先明确这份清单的交付物是什么。是让开发在模板里加导航链接,还是让编辑在文章正文中插入引用链接,或是让运营配置一批跳转链接?交付物不同,清单的详细程度也不同。
可以按以下顺序倒推:
举例来说,假设需求是“在帮助中心每篇文章底部加一个返回目录的链接”。这个描述太粗。倒推后应写成:在帮助中心文章详情页正文结束后、评论区之前,插入一个文字链接,链接文字为“返回帮助目录”,指向目录页地址,当前窗口打开。由内容编辑提供目录页地址,前端在模板中实现,测试人员检查链接可点击且跳转正确。这里的目标地址是假设示例,实际应以项目提供的地址为准。
一份能执行、能验收的HTML链接需求,建议逐条包含以下信息。字段不必全部出现在简单任务中,但缺失的字段要有明确说明,而不是留空让人猜。
如果链接文字涉及图片,还要写清楚图片的替代文字,以及图片无法显示时用户看到什么。如果链接指向PDF或压缩包,应注明文件类型和大致大小,便于判断是否需要单独提示。
HTML链接用法中,常见类型包括站内页面链接、锚点链接、下载链接、邮件链接和电话链接。需求清单要针对类型写出具体写法要求,而不是笼统说“加个链接”。
站内页面链接:写明目标页面的路径或由哪个字段生成。如果使用相对路径,要说明相对于当前页面还是站点根目录。验收时检查是否出现404或跳转到错误页面。
锚点链接:写明目标页面中的锚点名称,以及锚点对应的标题文字。验收时检查点击后是否滚动到正确位置,而不是只跳到页面顶部。
下载链接:写明文件名称、格式和存放位置。如果文件会更新,要说明更新后链接地址是否保持不变。验收时实际点击一次,确认下载的文件与需求描述一致。
邮件链接和电话链接:写明邮件地址或电话号码,并说明在桌面端和移动端的预期行为。移动端点击电话链接应唤起拨号界面,桌面端可能没有反应,这属于正常差异,需求中应提前说明,避免验收时产生争议。
技术示例中提到的标签应写成转义形式,例如在讨论标题结构时写<h2>,而不是直接输出标签。这样做的目的是让需求文档本身不被浏览器解析成页面结构。
验收不是“看起来没问题”,而是逐项核对。以下检查项可以直接放进需求清单末尾,由验收人逐条确认。
如果某一项无法当场验证,例如站外链接需要登录才能访问,应在清单中注明验证条件和替代验证方式,而不是直接标记为通过。
需求清单写到能验收即可,不必把实现代码全部写死。判断标准是:执行人是否需要额外做决定。如果执行人需要自己决定链接文字、目标地址或打开方式,说明清单太粗;如果清单把每个标签的属性都规定到无法替换实现方式,可能太细,反而限制开发。
一个实用的折中方法是:需求写“结果和约束”,不写“具体代码”。例如写“链接文字为‘查看定价’,指向定价页,当前窗口打开”,而不是写“使用某个标签并添加某个属性”。执行人可以选择符合结果的实现方式,验收人只核对结果。
第一次接触这个问题时,可以先从一条链接开始,按上述字段写完整,再交给另一个人执行和验收。如果对方能顺利完成且验收结果一致,说明详细程度合适;如果对方反复提问或验收结果有分歧,就补上缺失的字段。下一步,挑出你当前项目中最容易产生争议的一条链接,用位置、文字、目标地址、打开方式、责任人、验收标准这六项重新写一遍,再对照实际页面检查是否一致。