文档工作组章程#

团队指南#

文档工作组团队指南

使命与目标#

文档工作组(“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 治理决策制定文件中确立的指导方针。