前言

本教程的受众是前端小白，在校大学生，刚学习编程还不熟悉前端的从业者等，目标是为他们提供前端基础入门的体系化知识内容，参考[掘金小册]的要求的内容形式，尽量做到小篇幅，高浓度，成体系，有收益 4点。考虑到我们的受众群体，在写作时请多从初学者的角度出发，基于他们已有的认知，循循善诱，娓娓道来，“多说些废话”。

写作规范 - 图1

由于参与我们手册编著的同学写作习惯各不相同，为了统一我们的文章写作风格，尽量减少低级错误提高文章质量，我们需要规定一下我们的写作规范，以及推荐一下常用的文章结构。

写作规范

详细写作规范参考阮一峰老师的《 中文技术文档的写作规范 》， 这里列几点比较重要常见的规范:

标题

小章节的一级标题统一使用 H3（标题 3）

空行

标题和段落之间空1行
段落之间空1行

缩进

段落之前不需要缩进

单词

单词和中文之间添加空格 : 介绍 React 和 Vue 的相关文章（注意空格）

代码缩进

代码缩进以2个空格为单位，首行不需要缩进

图片

  1. 居中对齐

  2. 如果是引用的图片，注明来源

  3. 为图片添加注释，例如

写作规范 - 图2
（事件触发后，事件处理函数或一些生命周期函数中的 setState 调用会被合并）

推荐大纲结构

了解目标群体，给他们抛出问题，通过逻辑推演引导他们思考解决方案，推演过程每一步都要基于用户已有的认知,有时候多唠叨几句能够让新手更容易了解你要描述的内容。

  1. ### 前言
  2. 清楚讲解本篇文章的的核心价值和目的 配以合理的介绍性的文字、图片、代码，
  3. 甚至是 Demo 对整篇文章的结构大纲有一个概述性的介绍，为后面的核心内容做铺垫和准备
  5. ### 核心内容(多个)
  6. 可以讲讲本文所描述的主题相关内容: 
  7. - 是什么？（What）：这个技术是什么，它的历史介绍等
  8. - 为什么？（Why）：为什么我们要使用这个技术，和其他技术之间的比较，延引相关技术内容
  9. - 怎样使用? (how): 如何使用这个技术，相关的配置项，使用方式等。
  10. - ...
  12. ### 总结
  13. 回顾整篇文章，对内容、核心产出、重点做一次总结 援引一些资源、开源库、书籍、文章链接，
  14. 让读者可以继续学习 给读者以与作者继续保持联系的方法…

总结

本文尝试通过规范写作方式，统一大家的文章写作风格，尽量减少低级错误，提高文章质量，希望大家能够遵守我们的写作规范，创造出高质量的文章内容。

参考链接: