編寫程式碼研究室

簡介

程式碼研究室是以 Markdown 語法編寫的互動式教學課程。我們會在 blocklycodelabs.dev 發布程式碼研究室。程式碼研究室會混合使用自然語言、程式碼範例和螢幕截圖,打造更有趣的教學課程體驗。程式碼研究室的目標使用者是跟著閱讀並執行程式碼。

撰寫程式碼研究室是貢獻社群的絕佳方式。這有助於分享知識,讓遇到相同問題的開發人員輕鬆解決。

如何製作優質程式碼研究室?

優秀的程式碼研究室應著重於特定主題,且容易閱讀。清楚說明使用者將建構的內容和學習的知識,並逐步引導使用者編寫及瞭解程式碼,以完成特定工作。

程序

如果您對程式碼研究室有任何想法,可以在 blockly-samples 存放區中提出功能要求。請說明您想教導的內容,以及在程式碼研究室中建構的內容。我們會討論並修正這個想法。 然後撰寫並提交提取要求。通過審查後,Blockly 團隊成員就會發布。

書寫提示

本頁其餘部分提供一系列提示和問題,引導您撰寫程式碼研究室。

如要快速瞭解技術寫作,請參閱技術寫作

觀眾

  • 目標讀者是誰?
  • 他們對使用 Blockly 的瞭解程度如何?
  • 他們想學習什麼?

設定

  • 使用者執行程式碼時,需要進行哪些最低設定?

如有需要,您可以在 examples 目錄中發布範例程式碼完成的程式碼

結構

如同撰寫任何文章,請先擬定大綱。大多數程式碼實驗室都適合採用這種結構:

  • 簡介
    • 課程內容
    • 建構項目
    • 注意事項
    • 設定操作說明
  • 步驟一:[在此輸入標題]
    • 說明/動機
    • 程式碼範例
    • 預期結果
    • (選用) 更多說明
  • ...
  • 步驟十:[在這裡輸入標題]
  • 摘要
    • 您學到的內容
    • 您建構的內容
    • 其他資源
    • 完成的程式碼連結 (如有)

雖然步驟可以超過十個,但如果達到二十個,建議您將其分成兩個程式碼研究室。

寫作風格

  • 使用對話式寫作風格。
  • 使用標題清楚劃分內容。
  • 使用項目符號清單,將大段文字分開。
  • 使用圖片和 GIF!

程式碼樣式

  • 您可以撰寫 ES5、ES6 或 TypeScript,但請在開頭告知讀者。
  • 遵循 Google 樣式指南