[TOC]

如何写好技术文档

参考文章或视频：

程序员要怎么写好一篇技术文章_哔哩哔哩_bilibili

一、文章的目的是什么

二、文章的目标对象

三、确认文章大纲

四、填充内容

五、写文章的一些技巧

5.1 多进行概括和总结

5.2

六、常见技术文档结构

6.1 问题解决过程

1. 问题描述
2. 问题分析
3. 解决过程
4. 总结

6.2 新技术分享

1. 技术介绍
2. 应用场景
3. 技术比对
4. 自身思考

6.3 结构设计和解决方案

1. 背景介绍
2. 现状问题
3. 业界方案
4. 阐述我的方案设计
5. 执行过程
6. 执行效果
7. 未来规划

6.4 工具使用经验

1. 出现背景
2. 设计原理
3. 解决什么问题
4. 工具说明
5. 使用效果
6. 踩坑记录