撰写详细设计文档后的一些反思
2017-05-16 16:48
204 查看
不久前加入一家新的小公司,老板让我写详细设计文档。我开始以为不就详细设计文档嘛,以前看别人写了这么多,自已虽说从没写过文档(任何文档,代码里的注释),但也不致于在这种小事上应付不了。但是真正做起来不是我想的那样简单。现在纠正一下自己以前的误解:
1、 写文档只要是个人都会,没啥技术含量。
-----写文档虽然不需要太深的技术,但是章节安排、格式设置、斜体、引文,这些小技巧不见得每个程序员都会用,或者有些人压根不清楚这些小技巧干什么用。这些小技巧运用不当可能引起读者对文档的误解。
-----文档章节安排合适,可以使读者对作者的整体表达有个清晰的认识
-----格式设置恰当,字体、字号合适,文档就既不会单调乏味,又显得详略得当,节约读者理解文档花费的时间。
2、写文档太费时间,不值得花这么多时间。
-----写文档太费时间,证明你思路还不清晰,所以写文档的过程正好可以理清一下你的思路,避免后期返工导致更多时间的浪费
-----写文档太费时间,也许是你写作功底还不行,这恰恰警醒你需要想办法来提升一下你的写作功底
3、程序员只要技术牛就行,会不会写文档不重要
-----文档不会写,技术一定牛不起来。技术牛人一定是通过不断总结自己所学,不数积累才牛起来。程序员不会写文档,很难积累,怎么可能牛起来。
-----我想大部分程序员通过阅读技术书刊来获取技术知识。不妨反过来想一下, 如果那个书刊的作者写作功底不怎的,你会有兴趣读下去吗,你能读懂吗。
-----文档不会写,表达能力肯定也是不行的。表达能力不行,思路一定是紊乱的。思路紊乱,写代码的花费的时间就更长,返工的可能性也越大,出BUG的可能性也越多,这样的程序员只能算码农,对怎个团队的价值不大。IT行业最不缺的就是码农,码农想提升自己的工资, 难!
转行做Java开发也有两年多了。回想这两年多时间的经历,心酸。
1、 写文档只要是个人都会,没啥技术含量。
-----写文档虽然不需要太深的技术,但是章节安排、格式设置、斜体、引文,这些小技巧不见得每个程序员都会用,或者有些人压根不清楚这些小技巧干什么用。这些小技巧运用不当可能引起读者对文档的误解。
-----文档章节安排合适,可以使读者对作者的整体表达有个清晰的认识
-----格式设置恰当,字体、字号合适,文档就既不会单调乏味,又显得详略得当,节约读者理解文档花费的时间。
2、写文档太费时间,不值得花这么多时间。
-----写文档太费时间,证明你思路还不清晰,所以写文档的过程正好可以理清一下你的思路,避免后期返工导致更多时间的浪费
-----写文档太费时间,也许是你写作功底还不行,这恰恰警醒你需要想办法来提升一下你的写作功底
3、程序员只要技术牛就行,会不会写文档不重要
-----文档不会写,技术一定牛不起来。技术牛人一定是通过不断总结自己所学,不数积累才牛起来。程序员不会写文档,很难积累,怎么可能牛起来。
-----我想大部分程序员通过阅读技术书刊来获取技术知识。不妨反过来想一下, 如果那个书刊的作者写作功底不怎的,你会有兴趣读下去吗,你能读懂吗。
-----文档不会写,表达能力肯定也是不行的。表达能力不行,思路一定是紊乱的。思路紊乱,写代码的花费的时间就更长,返工的可能性也越大,出BUG的可能性也越多,这样的程序员只能算码农,对怎个团队的价值不大。IT行业最不缺的就是码农,码农想提升自己的工资, 难!
转行做Java开发也有两年多了。回想这两年多时间的经历,心酸。
相关文章推荐
- 撰写详细设计文档后的一些反思
- 撰写详细设计文档后的一些反思
- 撰写详细设计文档后的一些反思
- 撰写详细设计文档后的一些反思
- 撰写详细设计文档后的一些反思
- 撰写详细设计文档后的一些反思
- 撰写详细设计文档后的一些反思
- 撰写详细设计文档后的一些反思
- 撰写详细设计文档后的一些反思
- 撰写详细设计文档后的一些反思
- 撰写详细设计文档后的一些反思
- 撰写详细设计文档后的一些反思
- 撰写详细设计文档后的一些反思
- 撰写详细设计文档后的一些反思
- 撰写详细设计文档后的一些反思
- 撰写详细设计文档后的一些反思
- rd如何撰写总体设计文档和详细设计文档
- 互联网公司研发RD如何撰写总体设计与详细设计文档
- 监控系统服务器设计文档_详细设计
- 目前比较流行的一些设计模式文档