# 本書編撰規范
- 本書將涵蓋教學過程中的所有備課資料
- 本書的編撰是個協同開發的過程,每個模塊由特定人員負責,出現版本沖突可能在目錄結構文件中,顧提交時請注意
- 各參與教員自己建立看云賬號,系統分配協同開發權限后使用
## 書名規范
統一使用小寫英文
- 標準教案部分(整體)
***示例:standard-ui-v1***
- standard:標準教案
- ui:大課程名
- v1:版本號
- 標準教案部分(單科)
***示例:standard-ui-01-ds-v1***
- standard:標準教案
- ui:大課程名
- 01:課程編排順序
- ds:子課程名
- v1:小版本
- 隨堂筆記
***示例:note-ui88-201710***
- note:筆記
- ui88:班級號
- 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
│
└─ds
│ ds-introduce.md
│ readme.md
│
└─assets
│ 001.png
│
└─ds-introduce
001.png
~~~
## 內容編寫規范
- 英文命名的準確性;
- 圖片選擇的美觀性;
- 排版的整齊性;
- 混合英文排版的前后空格;
- 段落的清晰。
## 參考文獻
Markdown 編寫說明: http://www.jianshu.com/p/q81RER
Markdown 編寫規范:https://github.com/mzlogin/chinese-copywriting-guidelines
**請務必認真閱讀**