【个人总结】从一个用户角度出发，如何写一篇文档（博客）

 内容不多，写给瞎写博客的自己

标题：要精准！

 如：“关于如何预防脱发”。

第一部分：简单描述清晰对应的问题

         首先请告诉我，这篇博客是做什么的，如：“本文详细介绍了中年油腻大叔怎样通过抽烟喝酒烫头等方式预防脱发”。这样，我可以很清楚的知道是不是我要的内容，我是个帅哥，我不需要看这个！飘然而去，节省大量的时间成本。

第二部分：

          写清楚应用运行环境、版本,特别是百花齐放的Linux，发行版本不同，软件版本不同很可能没有参考价值。特别是XXX中间件引入，XXXX软件的安装，XXXX异常解决这种类型的博客，首先要写清楚基本信息，

  例如：

  软件安装类：
  Linux： CentOS7.5 
  MySql 8.0.0
  安装方式：安装包安装（下载地址：XXXXXX）/编译安装/命令行安装（前置条件安装yam并且配置好yam原）

  中间件接入类：
  系统环境：macOSX 10.16
  IDE    ：Intellij Idea
  框架    ：SpringBoot 2.2.2RELAESE 

  接入的中间件信息： 
  RockMq 软件版本：v4.6.0
  软件依赖项：
  64bit OS, Linux/Unix/Mac is recommended;
  64bit JDK 1.8+;
  Maven 3.2.x;
  Git;
  4g+ free disk for Broker server

  RockMq SDK版本：

<dependency>
      <groupId>org.apache.rocketmq</groupId>
      <artifactId>rocketmq-client</artifactId>
      <version>4.5.1</version>
  </dependency>
  <dependency>
      <groupId>org.apache.rocketmq</groupId>
      <artifactId>rocketmq-acl</artifactId>
      <version>4.5.1</version>
  </dependency> 

  RockMq 相关
  官网：http://rocketmq.apache.org/docs/quick-start/

   https://help.aliyun.com/document_detail/128602.html

第三部分：解决方案

此部分是详述。

第四部分：

FAQ，遇到过哪些坑，官网哪些地方会误导人。