文档即代码如何帮助 Pinterest 提高文档质量

主要观点:Pinterest 工程师多年来致力于在组织内采用“文档即代码”,通过使用相同工具和流程处理代码和文档,改善了整体文档质量和团队满意度,转变了文档文化,带来诸多益处。
关键信息:

  • 使用“文档即代码”意味着将文档视为代码,使用 Markdown 等标记语言,用源控制工具管理,执行 CI/CD 流程验证和发布,自动生成 HTML 站点。
  • Pinterest 采用 Markdown 和 Git 标准化,将文档集成到审查和部署管道中,开发专门工具管理文档。
  • 之前流程和工具存在问题,如更改和反馈迭代困难、确保利益相关者审查更新难、文档可发现性低等,采用“文档即代码”策略可解决。
  • 还带来更易有最新文档、早期发现设计或可用性问题等好处。
  • Pinterest 开发内部工具 Pinterest Docs(Pdocs),可在多个存储库中托管文档,避免为每个存储库设置新文档项目的开销。
  • Pdocs 可爬取pdocs.yaml文件将 Markdown 文件解析为 HTML,CLI 工具简化使用。
  • 内部调查和反馈表明在 Pdocs 中编写和浏览文档体验比现有工具好,创建“Wiki 到 PDocs 转换器”使两个月内文档项目增加 20%。
  • 除 Pinterest 外,许多大型组织也采用“文档即代码”,Write the Docs 网站是开始的好地方。
阅读 159
0 条评论