EtsyのDocs-as-code

ドキュメント・アズ・コードは、開発のためのドキュメントを、コードと同じツールとプロセスで統合します。バージョニング、プレーンテキスト・マークアップ、自動化を強調し、ドキュメントの管理を改善します。 EtsyのDocsbuilderツールは、ドキュメントの作成と維持のためにMarkdown、Docusaurus、GitOpsワークフローを使用します。 Docsbuilderは、Google Cloud Buildと統合テストを使用してサイトの作成、検証、デプロイメントを自動化します。 Docsbuilderは、検索エンジンと頻繁に使用されるサイトのナビゲーションコンポーネントで発見性を向上させます。 Etsyは現在、Docsbuilderサイトで6.2kページ以上をホストしています。 ドキュメント・アズ・コードの目的は、ドキュメントの品質、効率、信頼性を向上させることです。 主要な原則として、ドキュメントを第一級市民として扱い、Gitでバージョニングし、プレーンテキスト形式を使用し、ワークフローを自動化することが挙げられます。 ドキュメント・アズ・コードは、開発者がドキュメントに対しても同じように厳しくアプローチすることを奨励します。 Etsyは、Docsbuilder内の発見性、ナビゲーション、コンテンツのエンゲージメントを向上させる予定です。 ドキュメント・アズ・コードは、ドキュメントとコーディングのバランスをとり、組織化された維持可能なドキュメントを生み出します。