1.什么是技术文档
在工作中或者在发布开源项目时,需要编写技术文档,以便别人使用时,或者自己过了很久之后去看不会一脸懵逼。
我觉得写技术文档应该是一个程序员必备的技能,好的技术文档包括以下几个特性:
- 结构简单:将自己的项目将按照问题出现的频率分为常见问题,高频问题,热点问题,别人就会有针对性的去看。
- 循序渐进:当别人用起来时,先从hello world开始,然后再是什么配置啥的,不然别人看都不想看。
1.什么是技术文档
在工作中或者在发布开源项目时,需要编写技术文档,以便别人使用时,或者自己过了很久之后去看不会一脸懵逼。
我觉得写技术文档应该是一个程序员必备的技能,好的技术文档包括以下几个特性: