扫码阅读
手机扫码阅读

需求分析七宗罪之如何让改了10+次的需求文档照样能够轻松维护?

66 2024-03-26
点击蓝字 | 关注我们


#
产品经理必聊的100个话题



第100期:需求文档没有传承

开发人员常常会说:“我不知道文档没更新”,“我按照需求文档进行开发”。然而,当由于文档管理方式或质量问题导致出现BUG时,责任往往会归咎于需求方。实际上,在实际工作中,不仅会因为文档管理不足而产生BUG,还会因为文档与代码不一致而无法作为参考。

由于开发人员的流动性较大,新人很难快速理解业务等多种因素,都会对项目推进产生影响。那么,作为产品经理或BA,如何从源头避免这类问题的发生呢?



森林式文档管理


Business Analysis





过去,由于文档管理不足,给项目带来了许多困难,大家可能都能举出至少五种以上的例子,这里就不一一列举了。现在我们直接来了解一下森林型文档管理方式。

一棵树由枝和叶构成,树形目录是一种常见的文档管理结构,各种电脑系统都在使用树形文档结构。多棵树放在一起就构成了森林。森林型文档结构通过以“模块”、“类型”、“角色”等若干个视角贯穿文档,可以方便地进行文档的规划和阅读,能够更好地解决过去需求文档管理中的各种问题。

图中的每个有颜色的矩形代表一个需求内容片段,这些片段可以是各种需求分析工具,如流程图、原型、决策矩阵、判定矩阵等。而对这些片段进行编目的方式则是建立有效的需求文档阅读方式的过程。

这里给出三个例子:

1.分模块视图:使用模块的方式来组织目录,这是最常见的方式。通过选择特定的模块,可以阅读相关内容。

2.多角色视图:通常利用标签等方式,让不同角色能够看到他们最关注的内容。例如,UI设计师关注UI原型,后端工程师注重业务逻辑和存储对象,前端工程师则关注交互方式。

3.项目管理视图:对于采用Scrum管理方式的项目,可以以用户故事为单位组织任务。

除了以上三种视图,还可以增加更多的需求文档管理方式,以便读者能够更快地找到自己关心的内容。每种视图都有自己的方式链接到需求片段上,支持各种快速阅读方法。

此外,这种文档管理体系还可以通过版本管理确保文档始终保持最新,快速确认文档版本之间的差异,并支持新人快速阅读等价值。

另外一个重要的注意点是分层。作为IT公司,我们都面临一个共同的问题:人员流动。当人员离职时,不仅是人员的离开,还有业务知识的流失。仅仅依靠简单的交接很难确保需求知识的全面传递。

如果我们能够提供给新人一种快速阅读的方法,让他们能够迅速了解需求的整体情况和自己负责部分的细节,那么就能够减少需求交接所需的时间,减少信息的丢失。

因此,通过快速阅读并掌握整体需求的章节规划模式,新人就能够迅速深入到自己负责的章节中,从而有效地缩短他们需要花费在阅读上的时间。

如上图所示,当新人加入团队后,可以按照以下步骤来快速掌握系统需求整体:

1. 阅读共同约定文档:新人首先阅读共同约定文档,了解团队的工作规范和约定。

2. 查看系统概述:接着,新人可以查看系统概述,了解系统的整体结构和功能。

3. 下钻到自己的模块:然后,新人可以深入到自己负责的模块中,详细了解该模块的需求和功能。

4. 通过目录连接到相关素材:通过模块中的目录,新人可以快速连接到相关的素材。这些素材可以包括UI设计、界面校验、逻辑定义以及其他相关资料。

通过以上步骤,新人可以快速掌握系统需求的整体情况。为了方便搜索和定位文档内容,建议使用Markdown格式的文档存储方式。这样可以进行全文搜索,快速找到所需内容的位置。

同时,可以通过搜索结果记录等方式,快速定位、阅读和修改相应部分,避免遗漏。此外,标签功能可以帮助快速找到相关文档集合,或者在文档子集中进行检索,以更好地定位需求片段。

原文链接: http://mp.weixin.qq.com/s?__biz=Mzk0MzM2OTQzOA==&mid=2247485305&idx=1&sn=5e405b76ce5e6d42e29f8a5e508f4cc4&chksm=c335bac8f44233de4762d69cc814e45e705225f913e64ea3141aaa2e4004ed406585b9db2820#rd