本文目的是如何编写出能够使开发人员更清楚工作任务的软件需求、设计文档。
一、明确编写目的
文档编写的背景、目的不能流于形式,真正能够指导开发人员了解清楚软件的应用场景。
二、画清晰的功能结构图
本系统软件包括哪些具体的功能项,哪些是新增,哪些是复用,不同功能的优先级。
三、以软件实现流程的角度描述功能
少说一些空话,内容很多,读后又感觉没什么用;或者单纯的从用户角度描述的功能;
主观感觉不太清楚、不好写的地方正是需要用心描述的地方;
编写者模糊的地方要标记好,找人弄清楚继续完善。
四、清楚软件架构设计视图
软件可以提供什么样的功能-----逻辑架构
软件代码的层次结构-----开发架构
软件的部署与网络结构----物理架构
软件的数据结构----数据架构
软件的性能特征----运行架构
五、好的模板格式
不同或相同层级设置对应字体及段落格式。工欲善其事,必先利其器。对工具的应用熟练度也是很重要。提升word、excel、ppt等的操作能力。