一个合格的IT程序员如何写好技术文档？

一个合格的IT程序员对此应该是驾轻就熟，如果你还不会写也没关系，毕竟不是每个人都能写好文档，现在赶紧来看看小编整理的写好技术文档指导教程吧!

一、基本原则

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等

以上内容为大家介绍了一个合格的IT程序员如何写好技术文档，本文由多测师亲自撰写，希望对大家有所帮助。https://www.duoceshi.com/xwzx-hydt/1433.html