在线客服
扫描二维码
下载博学谷APP
扫描二维码
关注博学谷微信公众号
程序员如何写好技术文档？一个合格的程序员对此应该是驾轻就熟，如果你还不会写也没关系，毕竟不是每个人都能写好文档，现在赶紧来看看小编整理的写好技术文档指导教程吧！
一、基本原则
1、结构清晰
所谓结构清晰就是用户能马上找到自己要查找的知识点在哪，分类清晰。有些文档爱用模棱两个的词，比如“1. 常见问题”，“2. 热点问题”,"3. 高频问题"。我有十万火急的事情，你来告诉我我到底是要先看哪个？
2、循序渐进
先从最简单的开始，然后慢慢深入。比如我们学习Java，一开始Hello World都还没跑起来就先说配置文件要怎么写，Java一大堆的xml配置文件老司机都看的眼花缭乱更别说新手，这种文档让人直接从想了解到放弃。
3、引人入胜
把能吸引人的地方展示出来，比如Unity 3D默认就带一个设计精良的游戏Demo，一看到就有学习的兴趣。如果提供的是Web API除了有详细的文档外还应该直接能在浏览器里模拟出一个可调用的Demo，而不是看着API文档还需要不停的尝试，不停的踩坑才能调通。
二、考虑因素
我们写作的目的是啥？
看文档的对象是谁？
主要想表达什么？
应该表达哪些内容？
怎样才能更有条理?
怎样才更容易让读者理解？
三、推荐图书和软件
1、推荐图书
《大象UML》、《UML精粹》
2、推荐作图软件
工欲善其事必先利其器。
作UML图推荐Viso、ProcessOn、PlantUml、UmlStar、OmniGraffle等。
3、推荐思维导图工具
mindnode、xmind、ithougthtX等
以上就是对程序员写好技术文档的全部指导啦，大家也别光看，动手实践才是真。
— 申请免费试学名额 —
在职想转行提升，担心学不会？根据个人情况规划学习路线，闯关式自适应学习模式保证学习效果
讲师一对一辅导，在线答疑解惑，指导就业！
上一篇：
编程语言排行榜2019年7月Java依然首位吗？
下一篇：
面试常见问题汇总 人际交往篇
相关推荐 更多
IT工程师分“五个等级”，你知道自己在哪个等级吗？
著名前苏联物理学家朗道曾经给出过一个五级物理学家的划分，吴军老师在此基础上提出了“五级工程师”的划分。IT工程师分“五个等级”，你知道自己在哪个等级吗？这个话题的意义不在于引发大家的焦虑感，而是帮助大家正面直视是自我定位，并给与自己一个未来奋斗的目标。
20413
2019-07-05 18:36:13
如何写出一手好代码?
如何写出一手好代码?这真是一个宽泛而又需要落实到具体的问题。我们都知道，良好的代码更易于阅读、理解、调试和修改，最重要的是它的缺陷也更少。下面的十条最佳实践应用于你编写的所有代码，或许能给你一些启示。
9758
2019-07-05 18:52:39
程序员常用的开发工具有哪些？
小编整理了IT程序员们经常用到的开发工具有可视化分析工具、查看匹配信息、IDE插件、算法可视化工具、在线诊断神器、查阅和搜索利器等。
7083
2020-03-02 17:12:24
学好编程的4大必备素养看看你缺哪个
本文详细讲述了学习编程必备的4个素养，以及如何学习编程、学习编程的几个方法，推荐了相关的在线学习编程的网站，系统的介绍了学好编程的主观因素及客观因素
8184
2021-08-16 12:06:22
程序员面对996该如何应对？躺平还是卷起来？
程序员面对996该如何应对？躺平还卷起来？谁曾想被996生活方式浸泡了一段时间后的周末路边野餐上，画面不能说惨不忍睹也可以算是风云突变了。挣钱的道路虽然艰难，但未来的生活是光明的，我们要在艰难中寻找一条通往光明的道路！
4683
2022-06-21 11:28:44
