01 团队规范

1 知识库规范

1.1 知识库结构

• 知识库：较大的学科分类。知识库示例如下图：
  
• 一级目录：知识库的下一级，专业学科分类，没有特别的规范，各位都可以自己创建。一级目录示例如下图：
  
• 二级目录：二级目录以作者命名，规范遵照“From 团队内名称”，如：“From 蝉”。二级目录示例如下图：
  强制：文档务必以某种方式标注作者，不要修改他人的文档
  建议：使用二级目录作为某作者的分组
  
• 文档：在二级目录下编写文档实体，文档命名标注序号，文档顺序按照序号排列。
  • 序号命名规范：“序号 章节名”，如：
    • “01 语雀简介”
    • “02 语雀规范”
    • “03 Markdown语法”
  • 文档列表示例如下图：

2 文档书写规范

暂时只提供语雀文档书写规范 建议：语雀文档严格遵守Markdown书写规范，方便保护文档格式 建议：语雀文档为方便其他团队内的阅读者参考，尽量保证详细的描述与严格的规范，不反对独特的书写风格，万众创新。。。

2.1 标题

强制：标题务必添加序号，序号格式可自定义 表格的表头一般加粗、居中、背景填充为灰色，这里使用语雀[1,7]

2.2 引用

一个 > 之后为引用，这就是一句引用 建议：一般用在标题下，介绍本章节内容，或引用摘录

2.3 有序列表

介绍有序列表的使用

有序列表一般用于操作流程，如下：

1. 第一步，我应该干什么。。。文字步骤示例：
   第一小步 —> 第二小步 —> 第三小步 —> 第四小步。。。
2. 第二步，我应该干什么。。。图片步骤示例：
   
3. 第三步。。。
4. 第四步。。。

有序列表还可以用来写其他顺序内容，根据实际情况选择

2.4 无序列表

介绍无序列表使用

无序列表可以用来写顺序不明显的称名信息，无序列表案例如下：

流的种类如下：

• 输入流, 从磁盘到内存(程序)
• 输出流, 从内存(程序)到磁盘
• 字节流: 8bit
• 字符流: 16bit
• 节点流: 池子
• 处理流: 水渠

2.5 表格

建议：表格最重要的是记录表头信息，降低其他阅读者的障碍

表格案例如下：

2.6 图片

建议：方便的情况下，尽可能增加图片的示例，图片需提前使用绘图工具进行必要标注

图片都添加上边框，这样白色的图也能看清楚图片的边界

2.7 行代码

• 建议：尽量减少行代码来标注代码，一般情况下都使用代码块 ，就算只有一行代码
• 建议：行代码可用来标注一些 专业名词 或 特殊字符 或 时间 等特殊信息。如： 特征 、 α 、 P 、 2020-12-9 等

  2.8 代码块

  print("代码块务必选择语言，花花绿绿的就很好看")