PinterestにおけるDocs-as-Codeの採用
Pinterestの社内開発者アンケートによると、技術ドキュメントが最大の課題であり、その問題は品質と発見可能性に集約されていることが明らかになりました。ドキュメント作成マラソンや、上級リーダーからの熱心な呼びかけといった従来の解決策は、持続的な改善をもたらしていません。2021年、Pinterestは新たなアプローチを試み、ドキュメントツールとプロセスを強化するためのさまざまな戦略を探求することにしました。その中でも「docs-as-code」戦略に焦点を当てました。このイニシアチブはPDocsと呼ばれ、技術ドキュメントの品質を向上させ、Pinterestにおけるドキュメンテーションの文化を変革することを目的としました。「docs-as-code」の理念は、マークアップ言語、ソース管理、コードレビューツール、静的サイトジェネレーターなどを使用して、コードと同じプロセスでドキュメントを作成することを含みます。この戦略を採用することにより、Pinterestはドキュメントの問題を解決し、優れたドキュメンテーションの実践、品質管理、および発見可能性を促進することを目指しました。PDocsは、さまざまなファイルパスとリポジトリからドキュメントプロジェクトを自動的に配置し、単一の中央集中型ドキュメントサイトを生成するために開発された、カスタムビルドの静的サイトジェネレーターです。PDocsは、エンジニアがシンプルな設定ファイルとMarkdownファイルを任意のリポジトリにドロップし、マージされると中央集中型ドキュメントサイトに表示されるような、開発者エクスペリエンスを実現します。PDocsのUIはプロジェクト中心に設計されており、お気に入り、最近閲覧した項目、および「公開」または「ドラフト」設定などの機能を備え、読者の信頼を維持しています。