文章目录
技术文档每天都会遇到,条理不够清晰,表达不够准确首先是很难让人理解,同时还会增加沟通的成本
我这边结合阮一峰的博客也结合我最近写文档的思路列一下
两个方向是实践类(包括但不限于 部署,搭建),预研学习类(包括 新技术,技术选型,新趋势)
实践类较为简单
先来个实例网站华为云的部署文档
1.t1
1.1 t2
1.1.1t3
a.
b.
c.
或者
-
-
-
这种来分开步骤和梳理逻辑
同时遇到的问题或者是要集中介绍和梳理的内容可以放在后面开头
问题这种一般先描述现象和问题,然后 列出解决方案不必纠结与 ,把问题讲清楚
在md也尽量使用规范 引用 代码块 需要分开使用不要乱用,对应主要的部分可以加粗高亮
对于第二种预研学习类
来个实例网站 阿里云 云数据库 hbase
先应该是基本概念 来介绍名词和这个技术或者服务的概览
列出类似的产品服务,描述这个技术和产品的特点 依赖的环境和 版本
给出实例代码和
有实例代码或者 sample来
