最近项目接近尾声,为了给其他客户做展示,需要提供大量文档。
由于在开发过程中没有把相关的文档准备好,结果这几天临时拼凑码字,项目组成员感觉写文档比调试程序还要累。
仔细总结发现有几个问题在开发过程没有重视:
1. 开发过程中只注重某个函数或者某个模块,只见树木,不见森林。
2. 不注重总结,调试完了就拉倒,没有总结性文档。真要写起文档来,感觉对业务还是不够熟悉。
3.工具使用不熟悉。 写好文档的前提就是对写作软件熟悉,对画图工具使用起来要娴熟。
4. 模版准备不充分。 公司提供给客户的文档模版必须是标准的,不能一个文档一个格式,必须统一。
5. 其实最核心的还是对业务一定要理解深刻,浮于表面的理解对文档写作绝对是一个痛苦的过程。
6. 文档审阅的流程需要重视,不能走形式。先把文档发给审阅者,审阅者必须写出书面的意见和建议,然后开会决定是否做出相应的修改。
7. 文档定稿之前,测试人员根据文档建立环境,然后做实际测试。 如果测试人员通过文档测试成功,文档才能最后定稿。