怎么样提高软件开发过程中相关文档编写能力

1.搞明白要写什么文档,RFP、SRS,还是立项计划书,还是概要设计文档,还是用例
2.找模板,找范文(公司的、网上的)
3.填空或者模仿。
4.写完给领导、同事看看,搜集反馈,反馈不错,就Ok了,否则,再回到 3 。


■网友
这个问题挺搞笑的。如果是为了应付检查而写的文档,复制粘贴再改改不就行了吗?
而如果不是为了复制粘贴而写的文档,那目的也很简单,大体上分为两类:一类是用来指导“我们将要做什么”的文档,另一类就是用来记录和描述“我们做了什么”的文档。关键就是把你觉得需要留给别人的信息都写下来。
第一类,我们将要做什么?那么大致就包括了对市场/需求的调研,以及由此形成的设计。如果用装修房子打比方的话,你首先得知道你要装什么样的房子,然后设计怎么去装。至于这个设计做到什么程度,敷衍的就是能看个原型或者效果,而精细的应该包括详尽的施工图。这和软件工程是一样的,如果要做详尽的设计,那么最后就差把设计直译成代码了。
第二类,记录我们做了什么的文档。这个部分比较多,整个开发进度的日志、会议纪要、往版本控制上提代码的说明、测试报告等等。不考虑成本的情况下当然是越详尽越好。
文档到底有多重要呢?举个都已经说烂了的例子。台湾某航空公司一架飞机,在轻微事故以后进行了维修,维修日志只写了“已经按维修手册进行维修”,20多年后飞机在飞行过程中解体,调查结果最后指向了20多年前那次不恰当的维修。而这一切因为在当时的文档里并没有体现出来是如何维修的,所以才导致这个隐患被隐藏了20年。
【怎么样提高软件开发过程中相关文档编写能力】 最后总结说,文档做成什么样,并不是带项目的人能完全左右的。你得看老板的脸色,看客户的脸色。如果最初老板和客户达成的项目周期就很不靠谱,那肯定没时间整那么细致了。最后产品质量得不到保证,这并不能完全把锅丢给带项目的人。因为最初客户想要的就是便宜货啊。

■网友
多读参考,多写,多修改,熟能生巧
■网友
把注释复制粘贴到word里就好。
■网友
卸腰先要搞明白写的是啥,再要了解软件来龙去脉前因后果,三要参照前人写的各种模仿,最后加工润色总结经验写出自己风格的文档


    推荐阅读