OCaml.org 電子報:2024 年 2 月

歡迎來到 OCaml.org 電子報 2024 年 2 月份的版本!此更新由 OCaml.org 團隊彙編。您可以在 Discuss 上找到先前的更新

我們的目標是使 OCaml.org 成為任何想開始使用 OCaml 並提高生產力的人的最佳資源。OCaml.org 電子報提供我們朝該目標邁進的進度更新,以及我們正在進行的變更概述。

如果沒有所有協助我們審查、修改和創建更好 OCaml 文件之傑出 OCaml 社群成員,我們無法做到這一點。您的回饋使我們能夠更好地安排工作優先順序。謝謝!

本電子報涵蓋

  • OCaml 文件:已發布新的文件,並已改進現有文件。
  • OCaml 食譜: OCaml 食譜的原型,提供簡短的程式碼範例,使用來自 OCaml 生態系統的套件來解決實際問題,目前位於 staging.ocaml.org/cookbook。
  • 深色模式:我們現在幾乎準備好發布深色模式了。
  • 社群區塊重製:我們正在準備社群區塊的線框圖,以便更好地呈現現有的內容。此外,我們開始初步工作,建立專用的「活動」頁面。
  • 一般改進:一如既往,我們也根據使用者回饋進行了一般維護和改進,因此我們將重點介紹以下一些工作。

貢獻者開放問題和 Outreachy 申請期

有針對外部貢獻者的開放問題。但是,由於 github.com/ocaml/ocaml.org 參與 Outreachy 申請期,我們在 3 月可能會缺少開放問題,因為 Outreachy 申請人會迅速接手這些問題。

您可以在此處找到貢獻者的開放問題

OCaml 文件

使用者測試

21 位勇敢的新手同意在透過線上文件探索 OCaml 並完成幾個程式設計任務時,被觀察一小時。非常感謝所有參加我們舉辦的使用者測試會議的參與者!

一半的使用者測試參與者使用了最近更新的教學,另一半使用了v2.ocaml.org/docs。我們從中得到的結論是

  • 學習 OCaml 並不難。然而,學習函數式程式設計是難的。大多數有先前 FP 經驗的參與者都成功完成了任務。
  • 對於沒有 FP 經驗的參與者,更新的文件在教導 OCaml 和 FP 方面比手冊略勝一籌。其中一些人使用新的教學成功完成了較複雜的任務,而所有沒有 FP 經驗的參與者使用舊文件都失敗了。

透過觀察參與者試圖理解任務並在文件中找到相關資料,我們已發現許多小的變更,這些變更可能會改善文件頁面上的使用者體驗。

相關的 PR 和活動

即將推出的 OCaml 食譜

我們在學習區新增一個新的、社群驅動的區塊:OCaml 食譜,這方面取得了一些進展。食譜旨在成為一個食譜彙編,提供程式碼範例,使用來自 OCaml 生態系統的套件來解決實際任務。

以下是我們正在考慮的設計

  • 類別:高階任務群組,例如網路、資料壓縮或命令列引數。
  • 任務:類別中要完成的單一事項,例如寫入檔案、發出 HTTP GET 要求或傳回結束狀態。
  • 食譜:使用套件的任務版本,例如使用 curlycohttp 的 HTTP GET。

一個粗略的原型位於 staging.ocaml.org/cookbook。我們收到的貢獻和使用者回饋表明,食譜的結構需要再次改進,直到準備好發布。

提供食譜回饋的好地方是此 discuss 討論串

相關的 PR 和活動

深色模式

在 12 月,oyenuga17 開始在 OCaml.org 上實作新的深色模式。

到目前為止,新的深色模式大部分已完成,但尚未經過充分的審查或測試。

我們已在 staging.ocaml.org 上啟用了深色模式,此模式基於您的瀏覽器/作業系統偏好設定。如果您想提供協助,可以瀏覽 staging.ocaml.org 上的深色模式,並回報您發現的任何問題,只需開啟一個 issue 即可。

已完成的頁面

社群區塊的重新設計

本月,我們開始針對社群區塊進行使用者研究,並收集了關於目前頁面的回饋和想法。其中,我們發現了以下幾點:

  • 社群區塊需要一個更好的活動目錄
  • 工作頁面需要更容易從社群頁面進入
  • 若能突顯 OCaml 生態系統中正在尋找貢獻者的開源專案,那就太棒了

如果您對社群區塊有任何意見,請隨時在此討論串中分享!

相關的 PR 和活動

一般改進

非常感謝許多在 2 月幫助改進 OCaml.org 的貢獻者。請在下方查看他們的列表!

相關的 PR 和活動