本文分享了编写技术文档中关于算法的解析方法，包括使用图示、视频配合文字解释、推荐实用工具如draw.io和幕布等。强调了语言解释的重要性，如流程描述、专业术语的适当使用和数学证明。同时，建议加入个人理解和思维导图，保持文档格式统一，并注重校对以减少错误。坚持不懈地学习和改进，形成个人风格的模板，是提升技术文档质量的关键。
写技术文档方法之算法篇：
- 图示或者做视频，并配上文字
花费时间太多了，有很多时间的时候可以考虑，这里面也有一些技巧，值得学习，但久了上手后就很快了
本人觉得好用的工具推荐：
- 画图工具 [draw.io ]和[process ]
- 思维导图工具 [幕布]
- 图片编辑工具[faststone] - 语言解释
2.1 你可以通过写流程把算法解释很透彻
2.2.可以有一句话深刻透彻，直接解释所有，有时候一点及一切，记得加粗
2.3加一些专业术语，可以显得你的专业性，最好是你可以对它进行解释，或者引入另一篇文章，推荐好的文章也很不错，这里加专业术语不可让文章越来越深奥，而是蜻蜓点水，给读者说明体系内的叫法，但是读者可以理解文章。通俗易懂才是要道
2.4用数学方法证明出来很不错，以为要很多的数学积累，但是我所见的算法题的证明不会很深，认真学过大学微积分的都不是问题，注意认真学过的
2.5加入自己做的思维导图或是图片
2.6也可以解释为什么用这种方法，就是说这种方式为什么适合，有什么好处
2.7及时修改，做更深入的铺垫，引发，启示
2.8关键字记得加粗表示
2.9偶尔可以加一些表情包，技术文档
最低0.47元/天 解锁文章
扫一扫
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
