Spaces:
Runtime error
Runtime error
docs: Add STYLEGUIDE
Browse files- STYLEGUIDE.md +22 -0
STYLEGUIDE.md
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# STYLEGUIDE
|
| 2 |
+
|
| 3 |
+
## 語言與措辭
|
| 4 |
+
- 課程內容與註解以 **繁體中文** 為主。
|
| 5 |
+
- 避免使用「台灣地區」措辭,直接使用「台灣」。
|
| 6 |
+
|
| 7 |
+
## Notebook 結構
|
| 8 |
+
每支 Notebook 建議包含以下段落:
|
| 9 |
+
1. 學習目標
|
| 10 |
+
2. 重點說明
|
| 11 |
+
3. 實作步驟(含完整可執行程式碼區塊)
|
| 12 |
+
4. 練習或作業
|
| 13 |
+
5. 延伸閱讀
|
| 14 |
+
|
| 15 |
+
## 程式風格
|
| 16 |
+
- 以 **教學清晰** 為優先,允許在 Notebook 內重覆程式碼(方便學員複習)。
|
| 17 |
+
- 變數命名具意義,必要時以註解補充脈絡。
|
| 18 |
+
- 使用 [PEP8](https://peps.python.org/pep-0008/) 作為 Python 基礎規範。
|
| 19 |
+
|
| 20 |
+
## 檔案命名
|
| 21 |
+
- Notebook 檔名以 `00_`, `01_`, `02_`… 開頭,保持執行順序一致。
|
| 22 |
+
- 資料集檔案建議用 snake_case,例如:`dialogues_raw.jsonl`、`sft.jsonl`。
|