15个商业需求文档书写的坏习惯,你中招了吗?

15个商业需求文档书写的坏习惯,你中招了吗?

来源:原文作者Jeff Magy

翻译:三田

作者简介

Jeff Magy是一位高级商务系统分析顾问。他在药房福利管理和医疗保健系统领域有十年以上的从业经验。他拥有Cal Poly圣路易斯奥比斯波的工业工程学士学位,这个学科提供的方法是他的职业完美的基础。jeffmagy@outlook.comhttps://www.linkedin.com/in/jeffmagy
如果一家餐厅地毯破破烂烂,餐具肮脏不堪,菜单油腻粘手,你对它提供的“健康”食物会有多放心?那么你的文件何尝不是如此?你的文档是承载着你的努力的容器。容器本身给了别人关于你和你的能力的第一印象。如果文件被呈现给外面的部门或实体,它变得更重要。大多数项目都是在一个紧凑的时间表上进行的,更侧重于需求获取的机制,而不是文档质量。这是你可能没有步入正轨的原因,容易在文件快捷方式和错误方面受到不好的影响。许多坏习惯的形成可以归咎于有关部门的“赶紧把它做完了”,而不一定要显示出大学生的水平。不管怎样,这些都需要严密的审查。 

以下是前15名写作产品需求文档的不良习惯:

01 发布的审批过的文档还带着标记,高亮和注释

在修改批准的文档时保留删除线是一种很好的实践,以方便修订可以被跟踪。微软Word跟踪更改也常用,但很快就变得混乱。在文档发布的时候没有任何借口留着这些删除线。邻居不需要看到你的脏衣服。在这种情况下,带着标记的文档就好像文档世界里的夏威夷穆穆花裙,色彩斑斓的尖叫着“我不在乎我的样子”。

02 在文档的应用说明范围内写要求

应用说明范围给出了产品的实现。这个范围简明扼要的给出总结性的描述。产品需求的细节部分应留到写需求的地方。

03 接受利益相关方的有条件批准

如果这样做,就会导致范围的不清晰。利益相关者应该已经参与了需求的创建。他们本可以声明从属关系,或者要求项目经理在日志中记录风险。

04 业务和功能需求混淆

理想情况下,”是什么”是由业务定义的商业需求来决定,而”怎么做”是由IT部门作为功能需求来实现。二者的独立的意图经常被误解。一家公司把业务需求混淆功能需求并不罕见。这通常是由于业务和IT之间缺乏对角色和责任的分界。
 
05 超出范围的陈述“任何不在规定范围内的内容”

这是懒惰的人的方式。您可能需要多了解这个主题,来明白这个主题的界限。会不会有不熟悉项目的同事产生混淆?这正是你消除这种困惑的机会。

06 漏掉的假设

假设往往被忽略,因为我们认为它们是显而易见的。假设有助于了解背景,并为范围提供一层细微差别。请记住,文档也要适用于没有参加启发会议的人员。

07 背景声明写的太少或内容缺失

分析师是右脑发达的,所以能很快记住需求。背景陈述更偏向使用左脑,而左脑一般很少得到锻炼。看到有多少人为不明晰的背景声明而挣扎,真是令人惊讶。不要以为所有的读者都知道背后的基础知识。

08 拼写错误

是的,我们有拼写检查,但太多拼写错误的单词仍然漏过。在处理这个问题时,你是否忽略了这种波浪线或有意拖延不改?或者有时软件不好,没有激活拼写检查功能。gremlins软件可能会拼写检查正文,但会跳过表的内容。即使拼写检查的功能也需要检查。

09 没有序列或分组的要求

人一般按时间顺序讲故事。需求文档也有很多说明。其中一些可能会令人困惑。按时间排列是重要的,因为一个要求实际上可以帮助提供下一个需求的背景。有些要求最好作为一个类来对待,并且分组在一个小标题中。这些要求的关系更加明显。

10 不使用附录

附录可以很好的解决混乱的格式,是一个放有用的信息的好地方。信息量太大而无法放在需求部分, 或者有的信息不是一个要求,但仍然有必要知道,附录就是你安插它们的地方。

11 没有获得第二双眼睛审批的商业需求文档

医生是他自己最差的外科医生。即使是作为最佳实践的从业者的大学生,也很难找到自己的错误。同行评审过程对此非常重要,可信任的同事可能只是看看,都可以避免巨大的错误和尴尬。

12 缺失或无意义的图表

一张图片胜过千言万语。当有图表时,大多数人会以视觉的方式进行思考和更快地理解。流程图不仅传达了当前状态,而且还可以用来阐明痛点和缺陷。表明未来状态的流程图可以在脑中建立一个阐明需求关系的框架。复制图表要小心。从执行计划启动会议复制出来的图表可能很好看,但可以很容易展现和你自己负责的项目无关的元素。

13 讲一个故事而不是提出需求

每一条需求都有自己的含义,不太可能混淆下一个需求。 商业需求文档通常支持瀑布式开发过程。这依赖于可以通过单个测试进行验证的个别需求。如果您使用需求文档作为敏捷软件构建蓝图的工具,那么以故事格式写需求可能适合您的情况。

14 分页错误

当你的最后一页被编号为“第11页/共13页”时,错误分外明显。

15 将部分留空

看起来你忘了完成你的工作,或者更糟糕的是,粗心的忽略了它。输入“N / A”不会让你的指关节流汗。你可以用“没有识别”来表现出你勤奋的打了更多的字。