不懂写作的设计师不是一个好程序员”,避无可避的软件开发文档

发布时间2018/9/18 20:15:16

下载次数 0 次 访问量321 次

这次我们聊一聊这样一个话题,避无可避的软件开发文档

软件开发文档是软件开发使用和维护过程中的必备资料。它能提高软件开发的效率,保证软件的质量,而且在软件的使用过程中有指导,帮助,解惑的作用,尤其在维护工作中,文档是不可或缺的资料。

只要你是软件开发人员,无论你正在经历的是软件开发的哪个阶段,要么需要你去写文档,要么需要你去学习文档。如果你想快速地开发出功能模块,如果你想开发出的功能模块符合需求,那么软件开发文档将是必不可少的。

软件开发的一个大概流程是这样子的:分析设计,编码,测试,交付验收,维护(这个流程可以分得更细,这里只是说个大概)。这个流程中所展示的五个阶段,每个阶段均需要有相应的文档产出。

在分析设计阶段,项目需要《系统设计概要文档》和《系统详细设计文档》;在编码阶段,则被要求编写《接口文档》;在测试阶段,又被要求编写《测试文档》;在交付验收阶段,需要向客户提供《系统操作文档》;即使到了项目最后的维护阶段,还要写《日常维护文档》。

为什么要说,“不懂写作的设计师不是一个好程序员”呢?

说,要懂写作,是因为写文档需要“编”。对程序员来说,每个按钮每个功能,客户自己试一下就知道了,而且按钮上都写了,旁边还有附带说明的。但是我们经常被教育说,要把用户当小白,而且是特别“白”的小白。于是,很简单的一个功能,你需要用一大段废话去描述。当然,对于程序员来说是废话的描述,对用户可能会是至关重要的。毕竟,不是每个人都是程序员。(这个世界分两种人,一种是程序员,另一种是非程序员)

说,要会设计,是因为文档除了文字之外还需要图片,而流程图就是其中一种。流程图,需要把操作中各个节点和分支的判断条件描述清楚,而这也是用户对你实现的功能符不符合需求的一个重要判断依据。

说了这么多,相信每个人对写开发文档这件事也是,又恨又恨。

那么以下是本次话题的讨论

  1. 除了以上列出的文档之外,软件开发过程还需要哪些文档?
  2. 你写过哪些文档?写过最长的文档是什么文档?最长的文档名称是什么?
  3. 你觉得哪些文档是必须的?哪些文档是多余的?

网友评论

发表评论

欢迎评论哦!