在线客服
扫描二维码
下载博学谷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等
以上就是对程序员写好技术文档的全部指导啦,大家也别光看,动手实践才是真。
— 申请免费试学名额 —
在职想转行提升,担心学不会?根据个人情况规划学习路线,闯关式自适应学习模式保证学习效果
讲师一对一辅导,在线答疑解惑,指导就业!
相关推荐 更多
微盟程序员删库事件始末
相信这几天闹得沸沸扬扬的微盟程序员删库事件,大家都有所耳闻了。近年来,类似程序员删库跑路的新闻屡见不鲜。其实无论是对于程序员,还是公司管理层来讲,这类事件的出现都是完完全全可以避免的。因此,我们都应该从中吸取到一些教训和经验。下面我们一起来回顾这件事情的始末,分析一下具体的损失情况和从中得到教训。
12647
2020-03-03 20:37:01
程序员应该选择去大公司还是小公司?
在程序员的职场生涯中,总会面临着许多的选择。今天我们要讨论的问题是,程序员应该选择去大公司还是小公司?其实这个问题没有一个固定的答案,适合自己的才是最重要的。尤其对许多人来讲,进大公司的门槛高,我们常常不能主动的选择大公司。当然 ,这也不是说在大公司的发展一定就好,下面我们一起来分析一下进大公司和小公司的利弊。
5164
2020-03-03 21:45:34
IT程序员要什么学历?学历和能力哪个更重要?
IT行业招聘一般设置最低学历为专科,专科这个学历,如果能达到就业的能力水平也能找到工作。学历是给HR人看的,而能力是留下来做事的真功夫,故做IT程序员能力比学历重要。虽说做程序员的能力比学历更重要,但是学历是入职的敲门砖,学历越高越好,求职的机会越多。
13795
2020-03-05 11:04:04
IT程序员未来发展前景
IT程序员未来发展前景比较广阔,程序员随着年龄的增长,面对日新月异的代码,感到力不从心,更年轻的程序员层出不穷,这些都是促使程序员向另一个方向进行转型。IT程序员除了软件测试、产品经理、运维、等职业生涯的发展方向,都是IT程序员职业发展的好选择!
3479
2020-06-09 11:21:15
程序员如何写出简洁清晰标准的代码?
简洁的代码不仅能让阅读者方便理解程序的意图,还能方便维护与迭代,规避冗长且臃肿的代码给人一种乱糟糟的感觉。简洁的代码在维护上花费更少的时间,更易于被阅读和领会,花费更少的时间去弄清楚实际问题进而为修复、修改、以及扩展等操作留下更多的时间;更清晰地交流想法,程序开发离不开协作而简洁的代码往往可以减少项目成员之间可能产生歧义。从长远来看犯更少的错误更快地解决问题。
2465
2022-03-10 15:54:44