# 技术文章格式

- Link: https://www.ixiqin.com/2023/01/01/technical-articles-format/
- Published: 2023-01-01T06:00:00+08:00
- Author: 白宦成

在查看一些技术文章的时候，看到一个不错的技术文章的范式，记录一下，这样后续我的技术
文章也可以写的更有价值一些，而不仅仅是一个笔记。

以下内容为对应的范式和我的批注。

## 结构

 1. 简要的 Intro：介绍你在做什么、遇到了什么问题。
 2. tl;dr ：总有人不想看长文，对他们友好一些
 3. 目标 + 结果：明确目标既可以帮你明确写作的目标，也可以框定问题的范围
 4. `Shortcuts taken` ：可以快速带走的 intro，也可以理解为是 tldr 的内容
 5. 发现问题、解决问题的过程
 6. 结果
 7. 待解决的问题：在这个过程中你可能会有很多的新问题，可以记录下来，以后慢慢研究