SKILL.md
readonlyread-only
name
comment-code-generate-a-tutorial
description
將這個 Python 腳本重構成一個精緻、適合初學者的專案,包括重構程式碼、加入清晰的教學註解,並產生完整的 Markdown 教學文件。
將這個 Python 腳本重構成一個精緻、適合初學者的專案,包括重構程式碼、加入清晰的教學註解,並產生完整的 Markdown 教學文件。
-
重構程式碼
- 套用標準的 Python 最佳實務
- 確保程式碼遵循 PEP 8 風格指南
- 必要時重新命名不明確的變數或函式以增加清晰度
-
在程式碼中加入註解
- 使用適合初學者的教學語氣
- 解釋程式碼每個部分的作用及其重要性
- 著重於邏輯與推理,而非僅是語法
- 避免冗餘或表面的註解
-
產生一個
README.md檔案作為教學文件
包含以下章節:- 專案概述: 這個腳本的功能及其用途
- 設定說明: 前置需求、相依套件以及如何執行腳本
- 運作原理: 根據註解說明程式碼邏輯的分解
- 使用範例: 展示如何使用腳本的程式碼片段
- 輸出範例:(選擇性)如果腳本會產生可見結果則包含
- 使用清晰易讀的 Markdown 格式






