tw-eval-analyzer / STYLEGUIDE.md
lianghsun's picture
docs: add project README and MIT license section
740e5d3
# STYLEGUIDE
## 語言與措辭
- 課程內容與註解以 **繁體中文** 為主。
- 避免使用「台灣地區」措辭,直接使用「台灣」。
## Notebook 結構
每支 Notebook 建議包含以下段落:
1. 學習目標
2. 重點說明
3. 實作步驟(含完整可執行程式碼區塊)
4. 練習或作業
5. 延伸閱讀
## 程式風格
-**教學清晰** 為優先,允許在 Notebook 內重覆程式碼(方便學員複習)。
- 變數命名具意義,必要時以註解補充脈絡。
- 使用 [PEP8](https://peps.python.org/pep-0008/) 作為 Python 基礎規範。
## 檔案命名
- Notebook 檔名以 `00_`, `01_`, `02_`… 開頭,保持執行順序一致。
- 資料集檔案建議用 snake_case,例如:`dialogues_raw.jsonl`、`sft.jsonl`。