原创 程序员如何写好技术文档?指导教程

发布时间:2019-07-30 18:33:48 浏览 4225 来源:博学谷资讯 作者:照照

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

     

    程序员技术文档指导

     

    一、基本原则

     

    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依然首位吗? 下一篇: 面试常见问题汇总 人际交往篇

相关推荐 更多

热门文章

  • GitLab上市,GitHub的最大对手来了!
  • 中办、国办发文!推动现代职业教育高质量发展!
  • 如何实现代码审查反馈?
  • 初学者,你有没有想过放弃这一行
  • 入门IT行业,首门语言该选什么?
  • 程序员的上升天花板到底怎么破?
  • 什么时候PHP成了最糟糕的语言?
  • 四大最危险编程语言,PHP竟然没有排名榜首
  • 大厂工程师薪资来了,速来围观!
  • 当了几年程序员后,他竟然选择转行到这个行业......
  • 查看更多

扫描二维码,了解更多信息

博学谷二维码