在线客服
扫描二维码
下载博学谷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岗位都会问哪类问题？大体来说，归纳起来有七类，分别是专业知识类、IT岗位胜任素质类、发散思维类、应聘动机类、自我认知类、情商和职商类以及反问面试官的最后一问。下面我们来详细分析一下其中的面试回答技巧。
16492
2019-09-23 16:29:57
IT程序员如何提高编程效率？
IT程序员提高编程效率的编程技巧，编码思维、注释代码、干净的代码、重构、复制粘贴代码、使用有意义的名称、测试代码、学会调试等环节都要注意细节。编写单元测试提高效率，训练编程能力，使用并改进开发库，阅读代码和技术资料等。
6727
2020-03-31 11:26:25
IT程序员热门岗位有哪些？
IT程序员热门岗位:人工智能、大数据开发、Java软件开发、Python爬虫开发、全栈开发等诸多岗位，IT行业薪资相比各行业的薪资水平来讲，都是比较靠前的，岗位也有很多。初学者一旦选定了某一个领域，就需要掌握这个领域的技能。
6869
2020-05-22 14:49:09
摸鱼？！求求你们可长点心吧
众所周知摸鱼存在于各个行业，程序员也不例外的，虽说摸鱼舒服，但是摸得不好，很容易摸鱼一时爽，没有年终奖。如何高级的摸鱼呢？把摸鱼摸到把游戏存进项目包里你见过吗？知道这个真相的小谷震惊得眼镜差点掉下来。
6645
2021-08-26 11:39:19
双码农家庭20年就能实现财务自由？这是真的么？
最近小谷发现某论坛出现这样的提问——如果夫妻两个都是大厂程序员的话，那么在一线城市买房是不是很简单？财富自由是不是很简单？假设一年存50万，算下来工作20年，就能存1千万，500万用来买房，500万用来理财或者放在银行吃利息。
7158
2021-09-06 17:55:03
