撰写不同的文档,满足不同的沟通需求
- ppt
面向所有的项目相关人员,介绍项目的情况。 - 项目需求
面向甲方技术人员,进行需求对标。 - 技术方案
面向甲方技术人员和程序员,给出总体、详细设计、流程图等。
自顶向下,逐步求精。从大到小。 - 程序
面向机器,实现所需要的功能。 - 程序界面
面向用户,提供数据分析结果、决策支持。在初期不一定是 GUI, 但尽可能把参数配置之类写成配置文件, 或者输入, 而不要固化到程序里面. - 测试报告
测试用例, 结果. - 项目进展报告
当前的进度,当前的困难,下一步计划。可以分成几个子任务分别讲进度。
面向导师和甲方。 - 论文
面向读者,提供方案和技术创新点.
建立数据模型, 符号系统, 以及数学表达式.
注意事项
- 不同文档有不同的规范
- 不同文档之间不可以出现互相矛盾
- 画图解释,效果最佳
- 越简洁明了越好
- 角色互换,理解对方的水平和痛点
- 麻雀虽小,五脏俱全。再小的项目都应有完备的文档。