蓝图和规格

文档团队使用 docs-specs 仓库 中的规格来维护大型变更。 批准的规格发布在 文档项目规格。 为了跟踪目的,为每个规格创建一个蓝图。

使用蓝图和规格

  • 对于任何交付成果或一组交付成果的大规模重组。

  • 对于需要先设计再提出补丁的基础设施或自动化工作。

  • 当向文档项目添加全新的交付成果时。

  • 当向现有文档添加大型章节以确保文档核心团队的参与时。

  • 对于需要内容和工具变更的工作,例如添加 API 参考站点。

  • 对于应该在项目团队会议上讨论的工作。

规格需要文档核心团队的两个 +2 票。 请参阅当前的 文档核心团队成员 列表。

使用针对特定仓库的 bug

  • 对于已知的文档内容问题,即使您需要进行多个补丁来关闭 bug。

  • 为了添加仅仅是缺失的内容。

  • 对于文档中的已知错误。

有关更多信息,请参阅 文档 bug