Swift 文档工作组
文档工作组是一个指导团队,负责帮助指导 Swift 的文档体验。
文档工作组将:
- 定义并优先处理满足 Swift 社区文档需求的工作。
- 积极指导文档工具(如 Swift-DocC)的开发。
- 制定管理 Swift 文档体验贡献的流程。
- 向 Swift 核心团队传达 Swift 社区的需求。
当前的文档工作组由以下成员组成:
- Daniel Grumberg
- Dave Verwer
- David Rönnqvist
- Dianna Ma
- Franklin Schrans(主席)
- Joe Heck
- Kyle Ye
- Sofía Rodríguez Morales
- Sven Schmidt
- Vera Mitchell
我们感谢以下荣誉退休工作组成员的服务:
章程
文档工作组的主要目标是为 Swift 社区提供出色的文档体验。为此,工作组将开发 Swift-DocC 等工具,以支持它希望为生态系统和未来 Swift 语言文档工作提供的体验。随着时间推移,工作组还将帮助制定编写高质量文档的指南,并推动整个 Swift 生态系统的文档体验保持一致。
在这方面,工作组成员会审查对文档体验的修改提案(无论是在拉取请求中还是在论坛中发布的想法),并提供反馈,以努力使这些更改与文档体验的目标保持一致。
工作组成员还可以发起项目来改进 Swift 文档体验的不同方面,例如文档的用户界面/用户体验设计和文档编写语法。
文档工作组成员由 Swift 核心团队和 Swift 项目负责人酌情任命,后者对工作组的决策拥有最终决定权。
成员资格
文档工作组的成员按照上述章程指导 Swift 的文档体验。如果您想加入工作组,请在论坛中联系 @swift-documentation-workgroup
。
连续三个月不参与活动的非活跃成员将被联系以确认其是否希望继续留在工作组。六个月没有活动后,他们将被从工作组中移除。
核心团队还会选择工作组的一名成员担任主席。主席对工作组没有特殊权力,但他们负责确保工作组顺利运作,包括:
- 组织和主持定期会议。
- 确保工作组与社区进行有效沟通。
- 在需要向核心团队提出问题时,协调工作组代表与核心团队之间的会议。
工作组成员将尽可能独立通过共识做出决定,并在就重要决定达成共识遇到特殊挑战时向核心团队提出问题。
沟通
文档工作组通过 Swift-DocC 论坛与更广泛的 Swift 社区进行有关 Swift-DocC 的一般讨论。也可以通过在 Swift 论坛上向 @swift-documentation-workgroup
发送消息与工作组进行私下联系。
社区参与
我们邀请所有人参与为 Swift 的文档体验和文档工作组的计划做出贡献。如果您想贡献,可以考虑:
- 参加文档工作组在 WebEx 上的公开会议(在论坛中联系
@swift-documentation-workgroup
了解详情)。 - 在 Swift 论坛中讨论想法,例如在 Swift-DocC 论坛中讨论与 Swift-DocC 相关的想法。
- 为文档工作组管理的项目开设议题以跟踪改进和错误:Swift-DocC、Swift 编程语言书籍。
- 参与 Swift 导师计划。