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 生态系统中推动形成统一的文档生态系统。
在此职责范围内,工作组成员会审查关于文档体验变更的提案,无论是以 pull request 的形式还是在论坛上发布的想法,并提供反馈,以努力以符合文档体验目标的方式整合这些变更。
工作组成员还可以发起项目,以改进 Swift 文档体验的不同方面,例如文档 UI/UX 设计和文档创作语法。
文档工作组成员根据 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 相关的想法。
- 提交 issue 以跟踪由文档工作组管辖的项目的增强功能和错误:Swift-DocC,《Swift 编程语言》书籍。
- 参与 Swift 导师制计划。