1. 聚能聊>
  2. 话题详情

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

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

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

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

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

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

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

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

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

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

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

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

奖品区域 活动规则 已 结束

  • 奖品一

    阿里云代金券 x 5

  • 奖品二

    星座淘公仔 x 2

  • 奖品三

    多功能工具箱 x 1

14个回答

2

微wx笑 已获得多功能工具箱 复制链接去分享

除了以上列出的文档之外,软件开发过程还需要哪些文档?
简单的、或者粗暴的,那就是没有文档。
如果是自有产品,可能还没有产品职位,然后呢,还要有各种文档,什么PRD、MRD、BRD,然后各种PPT;
如果是外包,什么合同、招投标说明书,防止扯皮的文档、备忘之类的;
《概要设计说说明书》、《详细设计说明书》简单点一个文档搞定,如果分的细一点,是不是有什么架构设计、UI设计、数据库设计、算法设计之类的?概要之前要先系统分析,可行性研究等。
售前的解决方案,售后的维护说明书,操作手册。
有的涉及到三方对接,还要有通信协议。
你写过哪些文档?写过最长的文档是什么文档?最长的文档名称是什么?
写过很多文档,但天生不是写文档的料,都写的比较差。
最长的文档应该说是招投标说明书了,几百页;人家专业的随随便便一两千页。
你觉得哪些文档是必须的?哪些文档是多余的?
文档是写给人看的,或者为了应付某个环节,如果没有它存在的价值,一个字都多余。

2

黄一刀 已获得星座淘公仔 复制链接去分享

除了以上列出的文档之外,软件开发过程还需要哪些文档?
这些文档真的都不是什么事,写可研才坑爹,退了又改,改了又退,过了项目还不一定能批下来。
你写过哪些文档?写过最长的文档是什么文档?最长的文档名称是什么?
我写过《可行性研究报告》、《概要设计说说明书》、《详细设计说明书》、《用户操作手册》、《项目验收报告》;我写过最长的是《可行性研究报告》,写了三个月,名字叫《福建省机动车驾驶培训监管服务平台可行性研究报告暨初步设计》;
你觉得哪些文档是必须的?哪些文档是多余的?
说真的,都是必须的,没有多余的,系统建设必须规范化,相应文档必须配套,不然一旦出现人员变动就很容易出问题。
PS:有幸中奖,不要代金券;

2

痞子姜 已获得阿里云代金券 复制链接去分享

除了以上列出的文档之外,软件开发过程还需要哪些文档?

需求与分析、原型设计、功能和界面设计、开发与进度、测试手册、操作手册、对外api文档、代码文档,可能还需要日报、周报

你写过哪些文档?写过最长的文档是什么文档?最长的文档名称是什么?

进度文档、测试文档、代码文档、对外api文档、操作手册。最长的应该是对外api文档,差不多四五十页。文档的名字好像是“xxx产品对接文档说明 v1.0”

你觉得哪些文档是必须的?哪些文档是多余的?

需求文档、测试文档、操作手册是必须的,此外每周小结也要总结一下,每天也要记录一下自己的任务进度。多余的文档好像没什么感觉,现在就觉得文档不够用,恨不得知道缺了那块文档能尽快补起来

1

aoteman675 已获得阿里云代金券 复制链接去分享

1、除了以上列出的文档之外,软件开发过程还需要哪些文档?
《软件设计功能说明书》,《××平台操作手册》,还有接口文档,项目命名规范,数据库设计,服务器架构设计等。如果是物联网项目,还要有通信协议,接口说明。蓝牙和wifi的连接协议。
2、你写过哪些文档?写过最长的文档是什么文档?最长的文档名称是什么?
写过《××平台操作手册》几百页,还有物联网通信协议,交互协议。
3、你觉得哪些文档是必须的?哪些文档是多余的?
说明类的都重要,项目交付是给用户的,培训完都需要发放一份操作手册。还有项目的交互设计、接口设计、数据库设计、模型设计,这些都是为了后期迭代升级必须,也是为了下一个人顶班用的。

1

海阔天空yy 已获得星座淘公仔 复制链接去分享

除了以上列出的文档之外,软件开发过程还需要哪些文档?
合同,原始需求文档,需求分析文档,界面原型设计说明,数据库设计文档,业务流程文档,项目进度表
每周的项目进度,等等的

你写过哪些文档?写过最长的文档是什么文档?最长的文档名称是什么?
除了合同,和原始需求,几乎都写过好像,另外还写过软件著作权的文档,
最长的文档应该是接口文档吧,当时项目用的接口特别多,光接口就就有50-60个。
最长的文档名称按当时的规范是 公司名+项目名+模块名+类型+日期,一般到了模块级别的文档就非常长了

你觉得哪些文档是必须的?哪些文档是多余的?
如是没什么个性化需求就一些通用的系统的话,就1,2个开发人员,大家都成手的话 啥文档都可以不要,有疑问沟通一下就行了。
如果系统稍微复杂一些或者有个性化需求的时候,就需要文档了,要不然组员互相之间光靠沟通成本就太高了。
这个时候,进入开发阶段,详细设计,界面设计文档肯定是必不可少的,要不然依照什么开发啊,其它的话,看需要,比如业务流程比较复杂的话,就画些流程图,数据库表比较多就弄个文档,如果任务按周或按天定量的话,相关的文档肯定也是要有的。

可能的话,想要工具箱。

1

浮生递归 已获得阿里云代金券 复制链接去分享

再次沙发~

除了以上列出的文档之外,软件开发过程还需要哪些文档?
界面设计需求说明、软件开发需求表、系统需求分析表、标书、需求变更申请表、项目进度记录表……

你写过哪些文档?写过最长的文档是什么文档?最长的文档名称是什么?
都写过吧,最长的是软件开发提成制度,11页左右,还没写完。要计算的因素太多,估计没几个月研究下来,写不完。最长的文档名称应该是单位名称+系统名称+文档类型,基本上两行是免不了的,搞不好标题都要三行。

你觉得哪些文档是必须的?哪些文档是多余的?
需求文档、系统设计详细说明、进度表都是必要的。或者说看项目大小吧,越大,需要的文档越多,越小,就可以越精简。比如,就一个只有基本功能的留言板的话,就什么文档都省了吧。等下写文档的时间比写代码的时间都要多。

0

姜小枫2 已获得阿里云代金券 复制链接去分享

平常分配任务有经常写的程序逻辑说明文档,有个好的逻辑说明方便开发也方便测试。还有测试服务器上线相关的操作文档,所有的开发人员可以随时更新服务器代码,提高开发效率。写的最长的应该就是后台系统操作说明文档了,随着功能的增加文档会越来越大,截图是最麻烦的事情,一张图片要说明一个功能的逻辑,还有就是程序员写的操作文档,都带着程序员的思维,一般客户都很难完全理解,需要多训练一下。

0

盖地虎王晓 已获得阿里云代金券 复制链接去分享

除了以上列出的文档之外,软件开发过程还需要哪些文档?
除了上面软件开发第一步就是软件开发需求文档呀,然后根据需求文档才有后面软件设计文档,另外后面还有软件开发流程文档,开发模块文档,软件的数据库字典,软件开发进度周期表,最后还有软件开发的更新说明文档。

你写过哪些文档?写过最长的文档是什么文档?最长的文档名称是什么?
我主要写过的就是需求文档,主要是针对客户提出的需求,把用户需求整理成工程师可以看的懂的文档,最长的文档应该是软件使用操作文档吧,文档名称就是“某某软件操作使用说明”,这个文档主是要针对客户在使用软件过种中各种功能的用法及使用过程中应该注意的一些事项。

你觉得哪些文档是必须的?哪些文档是多余的?
我觉得这些文档都是必须的呀,没有说多余的东西,关键是这些文档你在规划过程中,要能做到目的清晰,结构清晰完整,意思清楚明白。让人在不清楚,不明白时可以迅速的查找的到,只有充不充分,没有多不多余。

0

shuyunfeng 复制链接去分享

我写过一个小的软件使用说明书,其他不清楚,哪位大牛有完备的一系列软件开发文档,或是编写要点,烦请附以连接,以供参详学习啊。多谢!多谢!

0

聆听、 复制链接去分享

独立开发。怎么写文档。

0

林明 复制链接去分享

除了以上列出的文档之外,软件开发过程还需要哪些文档?

项目做完以后,要做回顾,总结文档是要的;要上线运维,这些文档也是不可少的。

0

1405333805406958 复制链接去分享

加油争取做到思维具象化

0

杨振东 复制链接去分享

你好

0

centreo 复制链接去分享

清楚简洁的说明最好