学习嵌入式教程怎么产出高质量文档
2022-01-18 10:14:03
115
0

  对于如何在学习嵌入式教程产出高质量文档,其实并不难,和写好代码一样,技术圈有了许多建议和经验分享,最大的难点是愿不愿意去摸索,去写。


  其实我们不妨将文档当成代码,而文档的书写也可以说是对代码的审视和完善。写文档的人都有一个最大的误解,以为文档是写给自己看的,支队自己负责,所以不管写不写都没啥所谓。



学习嵌入式教程怎么产出高质量文档



  但文档在写之前就要确定给谁看,首先排除自己。当你作为团队的一员时,你就会发现体会更加明显,因为团队中有新人,有老手,怎样让自己的文档通俗易懂,不落俗套呢?其实不是一定要严肃完美,而是要说明问题。


  对于新手你或许需要写得详细一点,而对于老手,你就可以写得简洁一点,但你的逻辑思维一定要清晰准确。我们一般可以将文档分为参考文档、设计文档、引导类文档等。我们更具不同的需求去编写不同的文档。



学习嵌入式教程怎么产出高质量文档



  参考文档也是大部分开发人员日常会使用和书写的文档,比如我们使用某个框架或者工具,都会有API说明文档,这就属于参考类文档。而设计文档书写的过程中要求尽可能考虑周全,例如该项目的存储、交互、隐私等。


  虽然写文档看似一件费时费力的小事,但里面却有着大学问,如果想要写出高质量的文档更是如此。谁也不能要求自己一瞬间就写出一份高质量的文档,所以想要写出高质量的文档,我们必须从学习嵌入式教程的时候抓起。


  本文原创 文章来源:好学谷 转载请标明出处:http://www.haoxuegu.com/

为什么让你学习嵌入式教程时就要写文档
刚接触嵌入式教程时的一些奇思妙想