开发文档怎么编写_需求开发之软需编写技巧

一、什么是软需?

软需全称软件需求规格说明书,是产品/项目在研发过程中必不可少的一份过程文档,主要由产品/项目的需求人员负责编写。

7ea3c92cf8349485e3e5d84ac06c4a3d.png

编写软需之前一般要先进行用户需求分析

二、软需的作用

软需的编写时间一般是安排在需求确定之后,代码编写之前,因为产品/项目的需求经过调研分析确定之后,总体上用户想做什么,怎么做已经确定下来了。

软需就是要将用户的业务需求转换为软件功能需求,软需的编写完成时间必须是在代码编写开始之前,因为软需决定了开发人员如何设计系统功能,如何编写代码,软需是开发人员的主要参考依据。

没有软需就轻易着手编码,很容易导致产品/项目返工,最后也得不偿失。

三、怎么编写软需?

一份好的软需能做到易读易懂无歧义,能大幅减少开发人员和需求人员之间的沟通成本。如何编写软需,笔者认为,既要从业务需求角度出发,也要从开发人员角度组织内容结构,遵循结构化思维模式编写。

5d3f6698eca9acd7fef7a75bd1692029.png

掌握结构化思维模式

总体而言,一份好的软需基本上都具备以下特点:

1、结构层次清晰;

2、主次分明;

3、前后贯通;

4、定义清楚无歧义;

5、范围清晰论述全面;

那如何才能编写出这样一份受欢迎的软需呢,笔者总结了以下要点:

1、理清思路,构建逻辑结构

编写一份文档之前,最好在思维层面能有一个清晰的思路,能将业务需求点梳理形成结构化的思维导图。这样编写出的文档就能固定在一个框架内,有助于形成文档的总体层级结构。

在编写软需时,做到业务点从大到小,从粗到细进行描述,而不必急于写具体的某个点,应该是从全局主干出发,构建要点框架。可以说,有了一个清晰的逻辑思路,软需也就成功了一半。

0386ee4249508e2e86ccd7b889b47864.png

学会思维导图

2、抓住业务需求重点,有主次

对于用户需求来讲,有一定要是实现的功能,也有可有可无锦上添花的功能。因此,从用户角度出发,在编写软需时,应注意把握需求的主次。重要的需求点要重点详细定义,而一些锦上添花的功能点则不用花太多精力。

3、业务需求保持整体一致

一份软需需要定义的需求往往是零散而又复杂的。一个需求点可能会在文中多次出现,即要考虑一般情况,也要考虑特色情况,有的需求规则可以复用,而有的可能要特殊处理。因此,当需求定义的篇幅较大,需求点较多时,需要注意保持业务需求点的前后一致性,不能相互矛盾,前后不一。

4、语言描述简洁准确

为增加一份软需的易读性,应力求在描述内容时,语言简练,尽量少使用不确定性词语;对于要参考或者要指定引用的地方,应具体说明,减少阅读者理解时的歧义。

5、业务需求考虑全面不遗漏

一份好的软需同时也应是内容覆盖全面,无业务点遗漏的文档。

为保障在定义业务需求时描述全面,笔者认为,在编写软需时,可以先以清单形式列举产品/项目涉及到的业务需求点,做好所有需求点考虑全面不遗漏,然后再逐个需求点填充,如此,输出的软需就不容易发生需求遗漏的情况了。

3be1d4c3e7ca21bde8cb9d3bdd72f43d.png

清单列举防止遗漏

6、掌握一定的编写技巧

俗话说,文不如字,子不如表,表不如图。为使编写的软需更容易为项目组成员接受和理解,在编写时应注意在编排形式和格式上的技巧。

对于重点或需要特别注意的地方应高亮标出;对于需要大量文字描述的内容应按点以清单条目方式列举,尽量避免大段文字;对于难以用文字描述清楚的内容,如涉及到较复杂业务流程的内容,应配合以流程图的方式进行说明。

四、软需的更新管理

软需并不是一层不变的,也需要进行更新管理,在项目管理规范中,一般要求建立需求基线。软需在编写完之后,一般需要进行评审,评审后有问题的地方需要修改。

同时,在产品/项目的研发过程中,随着代码编写的深入,会逐渐发现软需的更多问题,因此,也需要在过程中对软需进行更新维护,以促进项目组成员对业务需求理解的一致性。

cbe0a30c173b2c41a1d512f436ba91a9.png

可以说,编写软需其实是一个细活,需思维严谨有规划。一份好的软需能为后续阶段的研发工作奠定坚实的基础,大幅减少人员沟通成本,减轻对人员流动的依赖,能有效增强文档的交付能力。

从另一层面来讲,编写软需的过程,也是锻炼一个人思维分析能力的过程,编写出一份好的软需,是需求开发人员的基本功。

  • 0
    点赞
  • 4
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值