文件工作組章程#

團隊指南#

文件工作組團隊指南

使命與目標#

文件工作組(“Docs Working Group”)作為一個支援、協助和諮詢機構,為 Jupyter 的各個子專案提供所有與文件相關的服務。我們使命的核心支柱是:

  • 改進整個 Jupyter 生態系統中與文件相關的方方面面。

  • 建立高質量的文件,使其清晰、全面、包容,並滿足 Jupyter 多樣化社群的不同需求。

  • 與社群互動,幫助使用者使用 Jupyter 產品,發現他們的需求,並將他們與相關資訊、專業知識和資源聯絡起來。

文件工作組將為整個生態系統的文件工作提供一個持續、專注、全面的投入場所。該工作組的部分存在意義在於為子專案提供能力和資源(其中一些子專案已經面臨資源/能力不足的問題,尤其是在文件工作方面)。

我們希望所有使用者在 Jupyter 生態系統內都能有積極的體驗,特別是初次接觸和正在學習的使用者,以及殘障使用者。

職責範圍#

文件工作組負責以下事宜:

  • 在必要時為文件制定標準。

  • 文件工作組將負責管理不屬於任何子專案的文件及相關資源。

文件工作組的活動#

為實現其使命,文件工作組將專注於以下工作:

  • 協助編寫文件(在各子專案治理框架內),包括元文件、跨領域文件(與多個子專案相關的內容)、開發者和貢獻者文件、非面向使用者的文件等。

  • 為文件編寫、資訊傳達、概念和風格制定最佳實踐建議和指南,以促進整個 Jupyter 生態系統的一致性。

  • 參與社群互動,幫助使用者與資訊、專業知識和資源建立聯絡;並從社群收集反饋,瞭解需要記錄哪些內容/他們需要哪些資訊。

  • 幫助支援和改進整個 Jupyter 生態系統中與文件相關的方方面面:我們的範圍也包括除編寫文件之外,任何有助於實現文件工作組目標的工作。為說明我們的工作範圍,下面提供一些澄清性示例:

    • 透過實施離線和互動式文件擴充套件,改善 Jupyter 應用程式內的使用者體驗。

    • 為文件網頁實施分析系統,以便更好地瞭解文件的使用情況。

    • 任何其他可能改善 Jovyans(Jupyter 使用者)在 Jupyter 生態系統中的體驗或理解的創新或工作。

創始成員#

  • Carlos Brandt

  • Carol Willing

  • Eric Gentry

  • Frederic Collonval

  • Michał Krassowski

  • Nick Bollweg

  • Paul Ivanov

  • Rosio Reyes

決策制定#

文件工作組將(根據 Jupyter 的慣例)成立一個理事會來進行決策。

文件工作組理事會最初將由創始成員組成。理事會成員隨後可以發起投票以增加新成員(或以三分之二多數票且全體理事會成員三分之二到場的情況下移除成員)。投票過程將遵循 Jupyter 治理決策制定檔案中確立的指導方針。