谈谈我对写文档的理解
我们写文档是为了在出现问题时可以追朔问题产生的原因。写文档一来便于查看交流,二来在查看文档时可以及时追朔当时的想法,三来便于出现问题时及时追朔。越忙我们越需要齐全的文档,项目越忙,我们越没有时间返工以及承担返工的后果,所以需要有完整的文档,文档并不能保证我们不出错,但是可以减小我们出错的概率。如果因为写文档而导致进度变慢,这是可以接受的,因为严格按照工作流程来办事,即使工期有所延误,也是一个可控的延误,比如一个作业有八个点需要去做,我们严格按照规则完成了四个点,也好过完全了八个埋着雷的工作点。
注意事项
1.在项目开始前是否已经了解了做这项工作的出发点和目的,达到怎么样的效果。不要盲目开发
2.所有的任务一定要有出处,有完成这项任务的先决条件,谁决定这么做的。到手的东西如果不满足开始该项任务的先决条件,一定不要盲目开始
3.我们目前的工作都是阶段性的。不要想着做一个完美的计划,写一个无需修改的文档,定计划写文档不是为了文档不变,而是为了应对其中可能出现的变化。
* 1.无论工作的简单与否,都应该有相对应的文档。我们写文档是为了在出现问题时可以追朔问题产生的原因,我们有设计文档,需求文档,程序设计文档,测试文档。一旦出现问题,就可以做到有据可查。
* 3.我们以文字性的东西,或者文档,图片等为依据,发任务时@相关人,提醒相关人及时去阅读,并在redmine任务里附上文件或者访问文件的路径,这样一来便于查看交流,二来在查看readmin任务时可以及时追朔当时的想法,三来便于出现问题时及时追朔,
* 4.越忙我们越需要齐全的文档,项目越忙,我们越没有时间返工以及承担返工的后果,所以需要有完成的文档,文档并不能保证我们不出错,但是可以减小我们出错的概率
* 5.如果因为写文档而导致进度变慢,这是可以接受的,因为严格按照工作流程来办事,即使工期有所延误,也是一个可控的延误,比如一个作业有八个点需要去做,我们严格按照规则完成了四个点,也好过完全了八个埋着雷的工作点。
* 6.在项目开始前是否已经了解了做这项工作的出发点和目的,达到怎么样的效果。不要盲目开发
* 7.为贯彻落实规范,公司将会更细致的量化考核,所有的任务一定要有出处,有完成这项任务的先决条件,谁决定这么做的。到手的东西如果不满足开始该项任务的先决条件,一定不要盲目开始
* 8.我们目前的工作都是阶段性的。不要想着做一个完美的计划,写一个无需修改的文档,定计划写文档不是为了文档不变,而是为了应对其中可能出现的变化。
* 9.不要做能力范围之外的计划,做好自己的事情为第一要义
* 10.不要总是站在自己的角度看问题,多站在别人的角度想想,想想他们这么做的本质时什么,达到什么目的
### 1.是否已经有了需求文档 和 业务流程图 草图 项目字典###
### 2.是否已经了解完全了解了做这项工作的出发点和目的,达到怎么样的效果 ###
【谈谈我对写文档的理解】### 3.是否做出了程序设计 和 控件规范 和 错误规范 ###
推荐阅读
- JAVA(抽象类与接口的区别&重载与重写&内存泄漏)
- 今天写一些什么
- 小影写在2018九月开学季
- 标签、语法规范、内联框架、超链接、CSS的编写位置、CSS语法、开发工具、块和内联、常用选择器、后代元素选择器、伪类、伪元素。
- 写给陈羡
- angular2内置管道
- 尖子生的启示(3)
- 写给我20岁时爱过的那个男孩
- 绘本与写作
- tableView|tableView 头视图下拉放大 重写