# 文档书写规范

by @huanglong

书写文档规则如下:

  • 新建语义化目录,按照 阿拉伯数据序号-文件夹名称 进行分组。
  • 前端规范统一放在 1-style-guide文件夹中。
  • 前端组件统一放在 2-components文件夹中。
  • 目录下新建 ****.md 文件作为功能性描述文件。
  • 如果当前目录代表整体功能,文件名只能为 README.md
  • 文件内容标题下添加作者,例如:书写规范 by @huanglong