关于如何写文档

技术文档如何写的清晰明了? 头大。(•̀⌄•́)
                              —— By Jihan


上一个我比较喜欢的技术文档书写风格示例

题目: 表述你文档核心内容
概述: 做基础背景介绍或目的介绍(默认阅读相关内容的人有相关行业背景)
内容: 按照一定逻辑进行叙述(大->小、流程顺序、时间顺序、依赖操作顺序)
其他: 引用和备注

示例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
---
title: xxx技术分析
date: 2021-03-09 10:29:26
categories: 技术杂谈
tags: [xxx]
---

从实践入门介绍nginx(•̀⌄•́)
                              —— By Jihan
* * *
<概要>:从模块开发了解nginx的使用以及nginx整体结构。从源码原理解析了解nginx底层设计和各种优化操作。

<!-- more -->
## 序
背景,或者预先需要了解什么

## 主要内容
### 观点1
### 观点2
### 观点3

## 其他
#### 可以列出相关的看过的书籍,或者问题参考链接网页一类的。
-------------本文结束感谢您的阅读-------------