簡介
程式碼研究室是使用 Markdown 語法編寫的互動式教學課程。我們會在 blocklycodelabs.dev 發布程式碼研究室。程式碼研究室會混合使用自然語言、程式碼範例和螢幕截圖，打造更有趣的教學課程體驗。程式碼研究室的目標使用者會跟著操作，並在閱讀程式碼時執行程式碼。
編寫程式碼教室是為社群做出貢獻的絕佳方式。這是分享知識的一種方式，也能讓下一位遇到相同問題的開發人員更輕鬆地解決問題。
怎樣才能製作出絕佳的程式碼實驗室？
優秀的程式碼研究室內容應聚焦且易讀。清楚告知使用者將建構什麼內容，以及將學習什麼內容，並引導使用者編寫及瞭解程式碼，以便完成特定工作。
程序
如果您有程式碼研究室的想法，可以在 Blockly 範例存放區提出功能要求，請說明您想教導的內容，以及您將在程式碼研究室中建構的內容。我們會討論並精進這個想法。接著，您可以編寫並提交拉取要求。經過審查後，Blockly 團隊成員就會發布。
書寫提示
本頁其餘部分提供一系列提示和問題，引導您撰寫程式碼研究室。
請參閱「技術文件寫作 1」，快速瞭解技術文件寫作。
觀眾
- 目標讀者是誰？
- 他們對 Blockly 的使用有哪些瞭解？
- 他們想學習什麼？
設定
- 使用者執行您的程式碼時，需要進行哪些最低設定？
如有需要，您可以在 examples 目錄中發布範例程式碼和完成的程式碼。
結構
如同任何寫作一樣，請先擬定大綱。這是大多數程式碼實驗室的理想架構：
- 簡介
- 課程內容
- 建構項目
- 注意事項
- 設定操作說明
- 步驟一：[標題]
- 說明/動機
- 程式碼範例
- 預期結果
- (選用) 進一步說明
- ...
- 步驟十：[標題]
- 摘要
- 您學到的內容
- 建構內容
- 其他資源
- 完成程式碼的連結 (如有)
雖然您可以有超過十個步驟，但如果超過二十個，建議您將其拆分為兩個程式碼研究室。
書寫風格
- 使用對話式書寫風格。
- 使用標題來清楚呈現組織架構。
- 使用項目符號清單分隔大量文字。
- 使用圖片和 GIF！
程式碼樣式
- 您可以使用 ES5、ES6 或 TypeScript 編寫程式碼，但請在開頭告知讀者使用哪種語言。
- 遵循 Google 樣式指南