學習 Web 開發寫作指南

MDN 的 學習 Web 開發 部分專門面向正在學習 Web 開發基礎知識的人員,因此需要與 MDN 的其他內容採取不同的方法。本文件提供了學習內容寫作的指南。

目標受眾

MDN 學習 Web 開發(也稱為 Learn)的目標受眾不是前端開發專家,包括學生、初級或學員 Web 開發人員、業餘愛好者以及希望獲得教學最佳實踐指南的教師。

主題覆蓋

Learn 提供了一個包含學習成果的結構化路徑,旨在教授將讀者培養成成功前端開發人員所需的基礎技能和實踐。學習者可以依賴它來獲取正確的學習資訊,教育工作者也可以依賴它來獲得正確的研究成果,並以此為基礎構建課程和教學大綱。

因此,我們的目標是嚴格限制 Learn 的範圍,使其僅涵蓋:

  • 在我們的 入門模組中的設定、軟技能和背景知識。
  • 在我們的 核心模組中,Web 開發人員旅程開始時所需的基礎技術。
  • 在我們的 擴充套件模組中,代表初學者掌握核心模組後可以繼續學習的有用後續步驟的“第二波”主題。

Learn 無意成為 MDN 上介紹所有主題的起點。這意味著諸如 MathML 和 Web Games 等小眾主題,以及正則表示式、效能測試、WebRTC 和 WebGPU 等高階或專業主題,都不屬於 Learn 的範疇。

如果您認為 Learn 中缺少某個主題,但您認為它應該被包含,請不要直接新增——而是先與我們討論(請參閱 建議內容)。

方法

要建立和更新 MDN Learn Web 開發內容,在很多方面,您應該遵循與 MDN 其他內容相同的流程。您應該遵循相同的通用 寫作風格指南程式碼風格技術

但是,也有一些區別:

  • 教程風格:MDN 的大部分內容是參考資料和指南的混合體;而 Learn 則旨在提供實踐教程。我們沒有嚴格的頁面模板,但應該以一種透過分步講解和“動手嘗試”部分相結合的方式,手把手引導讀者的方式來撰寫。這些內容應指導讀者動手嘗試,並開始編寫程式碼。例如,請參閱我們關於“搜尋引擎”資訊的 搜尋引擎 下的“動手嘗試”部分。這些內容是使用以下 Markdown 建立的:

    md
    > [!CALLOUT]
    >
    > **Try it out**
    >
    > Try this...
    
  • 挑戰:Learn 內容會定期包含挑戰,以測試讀者在進入下一篇文章之前是否理解了他們所學到的主題。這些挑戰目前有幾種不同的寫作風格,例如請參閱 挑戰:內容頁面結構測試你的技能:HTML 影像,但我們希望將來能提高這些挑戰的一致性和使用者體驗。

  • 密度和完整性:MDN 內容通常以其全面性而聞名。Learn 內容則並非如此詳盡完整。它的密度較低,方法更溫和,以便學習者能夠掌握有用的技能並取得穩步進步,而不會感到不知所措。他們以後可以深入研究。Learn 內容可以省略一些細節,以提供更舒適的學習體驗,前提是它不會向讀者教授任何誤導性或不良實踐。

  • 穩定的學習成果:每個教程頂部的學習成果總結了該教程所教授的內容,這些教程共同構成了前端 Web 開發的結構化課程。學習成果和教學內容保持穩定和同步至關重要,否則內容就不能作為正式學習(例如教育課程或認證)的基礎。因此,對學習成果的更改應緩慢進行,並且要經過深思熟慮。如果您嘗試新增未包含在相關學習成果中的內容(反之亦然),您的拉取請求將被關閉。請先 提出建議

注意:我們維護一個 變更日誌,其中詳細介紹了對學習成果所做的任何重大更改,以便教育工作者能夠維護基於 MDN Learn 的任何資源。

正如我們在 外部連結指南中所述,MDN 通常不允許出現似乎認可商業產品或服務或指向付費內容的外部連結(或嵌入)。這是為了降低 MDN 內容因充斥垃圾連結而失去信任和變得不那麼有用的風險。

MDN 的 Learn 內容對此有一些例外。我們允許來自特定受信任合作伙伴站點的外部內容(可能需要付費)的連結。這些是 MDN 透過仔細審查其質量、道德標準、對 Web 標準和最佳實踐的承諾,並幫助他們更新不符合我們標準的網站,從而建立了信任關係的網站。我們相信他們不會在未經通知的情況下更改連結,並且相信他們的內容是安全的連結物件。

這些合作伙伴連結的目的是:

  • 提供對支援內容的訪問,這些內容建立在我們頁面所教授的內容之上。
  • 提供對多媒體學習體驗(影片、幻燈片、其他互動內容)的訪問,而 MDN 內容團隊沒有資源來製作這些內容。MDN 內容以文字為主,但人們通常需要不同的學習方法。
  • 透過聯盟連結到付費內容選項來賺取收入,我們可以將這些收入用於使 MDN 變得更好。

然而,我們

  • 不會以損害 MDN 內容的完整性且明顯是垃圾連結的方式新增這些連結;僅在我們認為它們真正有用時才會新增。
  • 始終確保付費內容旁邊提供免費選項。在許多情況下,我們已成功說服合作伙伴免費提供以前需要付費的內容。
  • 將始終用“MDN 學習合作伙伴”標籤清楚地標記合作伙伴內容,以便您可以清楚地區分它們與其他連結。

在 Learn 內容頁面上,底部出現的“參見”連結應按以下順序排列:

  1. 內部連結。
  2. 指向免費內容的連結。
  3. 指向混合免費/付費內容的連結。

當前教育合作伙伴