关于总结文档书写的感悟

做项目的过程中时常需要记录&＃xff0c;最后把过程的资产变成有助于以后回顾或者使用的工具。因此写出好的文档非常重要&＃xff0c;可以节约自己和他人的时间。写出简单易懂的文档方便了问题的理解对自己也是一种提升。

文档就像是我们曾经的作文一样。以一个项目总结为例&＃xff0c;我们首先表明&＃xff0c;我们干的是什么&＃xff0c;实现了预期怎样的效果&＃xff0c;然后详细的描述这个过程&＃xff0c;最后对项目进行总结。有种总分总结构的感觉。

最近也输出了不少文档&＃xff0c;也算是总结到了部分经验&＃xff0c;写文档不要急于下手&＃xff0c;先想好自己要写什么&＃xff0c;看看写出的这个结构能不能达到让别人理解的目的&＃xff0c;如下图给大家安利一下这个软件可能大多数人都已经用过了&＃xff08;思维导图&＃xff09;&＃xff0c;免费的也是挺不错的。文档是写给人看的&＃xff0c;自己写出的东西如果过一段时间自己都很难理解&＃xff0c;那别人怎么能够理解。因此下手之前一定要多想&＃xff0c;好的结构意味着少的修改&＃xff0c;好的文档只需要好的执行力&＃xff0c;不会有别人再来打扰你。

在第一部分介绍自己的项目时一定要注意&＃xff0c;说出自己目前开发或者研究出成功的边界。不要让别人去猜&＃xff0c;一千个读者心里有一千个哈姆雷特。我这个设备测量温度的&＃xff0c;范围0℃到100℃&＃xff0c;描述一定要准确&＃xff0c;单位什么的是必须的&＃xff01;

第二部分娓娓道来&＃xff0c;最好图文并茂&＃xff0c;大段的文字很难让人理解&＃xff0c;有一些操作用文字也很难描述清楚&＃xff0c;这时候带有描述的图片可以说是大显神威&＃xff0c;让人瞬间会有阅读的兴趣。大家可以看看大博主的博文&＃xff0c;每一张图片都会让你有种精挑细选的感觉。

第三部分需要写目前的局限等等&＃xff0c;有问题一定要抛出问题。

很重要的东西一定不要放在附录里&＃xff01;&＃xff01;&＃xff01;