优秀程序猿写技术文档的正确姿势 |
您所在的位置:网站首页 › 姿势要怎么写 › 优秀程序猿写技术文档的正确姿势 |
一、背景
写文档是程序猿进阶的一个必要步骤之一。 文档写的清楚,思路就更加清晰,也会让同事高看你一眼,多梳理业务也有很大帮助。 产品经理对需求文档基本是驾轻就熟信手拈来,但是大多数程序猿写技术文档却显得不够专业。 最近有小伙伴问怎么写技术文档,结合了多个优秀的技术文档的范例,总结了技术文档的框架。 二、框架话不多说,直接上干货。 2.1 技术文档的架构关键是能够条理清晰,然后配各种UML图,表格等。 2.2 考虑的因素我们主要考虑: 我们写作的目的是啥?看文档的对象是谁?主要想表达什么?应该表达哪些内容?怎样才能更有条理?怎样才更容易让读者理解? 三、推荐图书和软件 3.1 推荐图书《大象UML》、《UML精粹》 3.2 推荐作图软件工欲善其事必先利其器。 作UML图推荐 PlantUml、Draw.io 等。 3.4 推荐思维导图工具mindnode、xmind、ithougthtX等 四、思考第二部分给出了技术文档的框架,引导我们去思考应该考虑的问题。 仅有这些还不够,实践是检验真理的标准,要去练习才能真正掌握这个框架。 另外看似有了框架啥都不是问题,照着填就完了,事实并非如此。 正如高考英语作文模板一样,框架都有了差不哪去,但是具体的内容千差万别,最终的分数还是有浮动的。 要想写好技术文档,写的更加专业还需要一些软能力,比如思维要缜密一些,画交互,画UML图的能力,画思维导图的能力的能力等,这些需要平时主动去学习和训练的。 五、相关参考优秀的程序员还可以考虑抢产品的饭碗,多学点总没错,可以看看这篇文章学学需求文档的写法: 《优秀产品经理写需求文档的正确姿势》 |
今日新闻 |
推荐新闻 |
CopyRight 2018-2019 办公设备维修网 版权所有 豫ICP备15022753号-3 |