学习一下阿里技术文档的写作方法

我觉得写的挺好的，如果让我写一个技术文档，我可能写的没有那么好，关键是学习一下写作结构，我相信只要大的框架对的话，就算语言水平差强人意，同一个圈子里面的人也能理解技术文档应该没有什么障碍的。

https://antv.alipay.com/g2/doc/index.html

这是阿里的一个数据可视化的js库，这个库叫G2

 

看下这个文档的结构，分为5个部分，分别是快速上手、教程、实例、API、更新日志

 

 

 

现在分析一下为什么要有这5个部分，技术文档时给技术人员看的，那么技术人员究竟需要什么样的文档呢，换位思考一下，我觉得这样就离答案不远了。

先看第一个部分，快速上手

这个部分主要是介绍了这个库的概念、特性、安装方法、一个简单的案例，所以综合一下这几个小节，快速开始的目的就是让人了解一下你这个库是干什么用的，给出一个简短的概括说明，怎么用、能实现什么样的效果就可以啦，再精简一下，迅速让技术人员明白

这个东西能实现啥效果。

 

使用教程部分给出了这个库的内置的概念，术语，相当于工具书这么一个东西，必不可少。

 

图标实例部分给出了各种实现的效果以及源码

 

API部分，就没啥好说的了，就是提供哪些接口以供调用。

 

更新日志帮助读者了解这个库的历史以及发展状况。

 

转载于:https://www.cnblogs.com/yfish/p/6984298.html