为什么要维护一份完整的软件功能的文档

为什么要维护一份完整的软件功能的文档
0

许多产品经理、产品助理,虽然有将需求写成文档,但只是每提一次需求写一份文档,没有维护一份完整的软件功能的文档。我认为,维护一份完整的软件功能文档,在提新需求时同时维护这份文档(将新增的功能写进文档,对于要修改的功能也对文档作相应修改),是利大于弊的,下面列出我在真实项目中发现的它的 3 个好处。

1、便于修改功能时检查是否跟原功能冲突。举个例子,一个APP之前没有要求用户必须输入电子邮箱,而现在产品想新增一个功能要用到用户的邮箱,如果没有一份完整的功能文档,那么产品就不容易发现“不是每个用户都在系统中有填写电子邮箱”,从而导致在实现这个要用到邮箱信息的新功能的时候出现问题。

2、便于新接手的同事了解软件全貌。如果没有一份完整的文档,在团队加入新的人员时,旧人员就需要花更多的时间和精力为新成员详细介绍软件已有的功能,而且还可能遗漏或弄错某些细节,尤其是一些比较长时间以前开发的功能,或者是已离职人员开发的功能。

3、便于向用户提供使用说明。如果有一份完整的功能文档,在编写软件的使用手册、软件使用的帮助文档或者系统的运维手册的时候,就能省事很多,不需要从头开始总结归纳软件的业务流程。