软件开发过程中会涉及大量的文档,比如详细设计文档、安装指导、升级指导等等。。大型的系统上百个文件都不算多。


咱们今天就来讲讲开发要写哪些文档?当然这个各家公司不一样。小编我紧以自己公司情况站在公司的角度聊一聊。仅供参考,欢迎拍砖吐槽。。。不胜感激。

当然长期坚持写文档绝对增强个人的叙事表达能力。


小编在以往的开发过程中,经常的被领导追着屁股写文档。现在想想头还大呢。以前想写文档干嘛呢。不是吹牛有问题找我解决不就完事了,咱分分钟就搞定了。


总结几点

  1. 怕烦  

  2. 没空

  3. 没有用

  4. 没有好处

  5. 不会写


随着时间的飘过,承担工作越来越多,项目版本的压力也是越来越大,没有那么多大时间和精力关注所有问题。但版本的质量是一定要保证滴!怎么办?

  1. 掌握的知识经验如何传递给其他的同事呢?

  2. 要是遇到一个特么恶心的问题怎么办?有多恶习?恶习的就是你,要不你怎么成为大牛。下次其他人要是也掉坑了咋办?请教前辈分分钟不就搞定了。重要的事说三遍,前辈离职了,前辈离职了,前辈离职了。

  3. 好不容易花了两天解决了一个难题。过来3个月咋问题又出现了。不可能,可是他又重现了。相关的资料没有记录。哎呀这个怎么破?哈哈你猜对了,以小编自身的经历来看30%都是重复的问题。


这几点您怎么看呢?


总结了整理文档的几条原则

  1. 重要的内容分点描述

  2. 流程性比较强的内容画成流程图

  3. 文字与代码结合,梳理伪代码

  4. 问题的背景、现象要描述清晰

  5. 文档要体现思路


微信关注【Java技术堂】

文档在项目中怎么就那么重要呢_java

文档在项目中怎么就那么重要呢_java_02