# 本书编撰规范 - 本书将涵盖教学过程中的所有备课资料 - 本书的编撰是个协同开发的过程，每个模块由特定人员负责，出现版本冲突可能在目录结构文件中，顾提交时请注意 - 各参与教员自己建立看云账号，系统分配协同开发权限后使用 ## 书名规范 统一使用小写英文 - 标准教案部分（整体） ***示例：standard-java-v1*** - standard:标准教案 - java:大课程名 - v1:版本号 - 标准教案部分（单科） ***示例：standard-java-01-mysql-v1*** - standard:标准教案 - java:大课程名 - 01:课程编排顺序 - mysql:子课程名 - v1:小版本 - 随堂笔记 ***示例：note-java96-201710*** - note:笔记 - java96:班级号 - 201710:开班月份 - 素质培养 ***示例：cq-english-v1*** - cq:素质培养 - english:课程名 - v1:版本号 - 知识点分享 ***示例：kp-springboot*** - kp:知识点分享 - springboot:知识点名称 ## 文件命名规范 - 按照课程的名称定义文件夹，文件夹中存在一个 `assets` 目录，用于存放图片等资源； - 所有文件夹统一使用英文小写命名，多个单词之间用 `_` 符号隔开； - 图片 assets 中按照课程的目录建立文件夹，所有图片命名从 `001.png` 开始，注意图片统一使用 `png` 格式； - 每一篇文章讲述一天 `3` 课时的内容量，文章命名使用关键核心内容命名，规则同第二点； - 每篇文章的示例模板如下篇介绍 整个教案的目录和文件组织结构大致如下： ~~~ │ demo.md │ norm.md │ preface.md │ README.md │ SUMMARY.md │ └─mysql │ mysql-introduce.md │ readme.md │ └─assets │ 001.png │ └─mysql-introduce 001.png ~~~ ## 内容编写规范 - 英文命名的准确性； - 图片选择的美观性； - 排版的整齐性； - 混合英文排版的前后空格； - 段落的清晰。 ## 参考文献 Markdown 编写说明： http://www.jianshu.com/p/q81RER Markdown 编写规范：https://github.com/mzlogin/chinese-copywriting-guidelines **请务必认真阅读**