2022 年の State of DevOps Report データの詳細: ドキュメントと太陽の光の類似点
Google Cloud Japan Team
※この投稿は米国時間 2023 年 6 月 16 日に、Google Cloud blog に投稿されたものの抄訳です。
編集者注: 毎年、Google Cloud の DevOps Research and Assessment（DORA）チームは、年 1 回刊行される Accelerate State of DevOps Report を通じて、ソフトウェア デリバリーと組織のパフォーマンスの理解を深められるよう努めています。このシリーズでは、その調査をより深く掘り下げ、2022 年の State of DevOps Report には収録されていない興味深い調査結果の一部をご紹介していきます。
内部ドキュメントはソフトウェア開発の基盤となるものです。過去 2 年間、DORA チームは内部ドキュメントの品質を注視してきました。チームで行った分析から、ドキュメントの品質と組織のパフォーマンス（パフォーマンス目標と収益目標を達成する能力）の間に明確なつながりがあることが判明しました。植物が成長のために水と太陽の光を必要とするように、優れた技術的手法とドキュメントを備える組織は、パフォーマンス目標以上のものを達成できる確率が大幅に高くなっています。
ドキュメント作成は非常に技術的な作業です。分析結果から、この作業によって多くのメリットを得られることがわかりました。今回の投稿では、以下の点について取り上げます。
ドキュメントの品質の定義と測定について
ドキュメントが技術的能力と組織のパフォーマンスに及ぼす影響
ドキュメントの品質を高めるためにチームに導入できる手法
ドキュメントの品質の測定方法
ルーメンやワットのような測定単位は存在しないため、ドキュメントの品質を定義して測定する方法を編み出す必要がありました。
調査には、明確さ、情報の見つけやすさ、信頼性など、ドキュメントの属性を評価する 8 種類の指標を使用しました。これらの属性を評価するために使用した質問文については、2022 年の調査の質問をご覧ください。
回答者ごとに回答を集計し、集計結果を 0～1 の間の数値に換算して標準スコアを算出しました。このスコアを算出したあと、独自のモデルに追加し、システムの他の要素とどのような関係にあるかを確認しました。
ドキュメントと太陽の光の類似点
2021 年の調査と同様、ドキュメントの品質が、調査対象のすべての技術的手法の実装を促進していることがわかりました。2022 年のモデルでは、これらの技術的能力を支えているのがドキュメントであることが判明しました。
しかし、さらに興味深い点は、ドキュメントの品質とこれらの能力の関係性が組織のパフォーマンスに影響を及ぼすことです。
その効果について見ていきましょう。以下のグラフは、継続的インテグレーションとドキュメントの品質の関係がどのように組織のパフォーマンスに影響を及ぼすかを視覚的に示したものです。
ここでは、独自のデータに基づく予測シミュレーション 3 セットを見ていきます。データに存在するある程度の不確実性（または確実性）を表すため、各セットで予測シミュレーションを 4,000 回実施しました。
上のセット（緑）: 平均を上回る品質のドキュメント（平均より標準偏差 1 つ分高い）
中央のセット（黄）: 平均の品質のドキュメント
下のセット（赤）: 平均を下回る品質のドキュメント（平均より標準偏差 1 つ分低い）
継続的インテグレーションの手法の実装は、x 軸で示されています。この技術的手法が実装されると、組織のパフォーマンスがプラスの影響を受けます。この影響は、ドキュメントの品質が向上するほど増大します。
十分に水やりした植物は、太陽の光があれば大きく成長します。同様に、品質の高いドキュメントがあれば、技術的手法によって、収益から顧客満足度まで、組織のパフォーマンスを高めることができます。
この関係性とそれによってもたらされる影響は、2022 年にチームが調査したすべての技術的能力に当てはまります。以下の表に、さまざまな技術的能力の実装に応じた、組織のパフォーマンスの上昇率を示します。平均を上回る品質のドキュメントを使用するチームでは、上昇率が著しく高くなっています。
ドキュメントに影響力がある理由
この点については、いくつかの要因を推測できます。たとえば、書くという行為は革新的なものを生み出す作業であるため、ドキュメントを書くことで作業の技術的品質が向上するという説があります。
2019 年の State of DevOps Report などの調査から、ドキュメントなどの内部のナレッジソースへのアクセスと生産性の間につながりがあることが判明しています。品質の低いドキュメントを使用して技術的手法を問題なく実装したチームは、大きな労力をかけてそれを実現した可能性があり、全体的な生産性は低下しているかもしれません。
つまり、品質の低いドキュメントを使用して機能を実装したチームの成功は、例外であると考えられます。周囲の他のチームは、技術実装に困難を抱えているかもしれません。これに対して、品質の高いドキュメントが存在する環境で技術的な成功を収めた場合、時間が経過しても組織全体で同様のレベルの技術的な成功を達成できると考えられます。
これらの要因やその他の要因を組み合わせたものが、ドキュメントからこれほど大きな効果を得られる理由であるかもしれません。確実に言えることは、技術的手法の実装を成功させるうえでドキュメントの品質が大きな影響を及ぼすということです。そして、品質の高いドキュメントは、これらの技術的手法が組織のパフォーマンスに及ぼすプラスの影響を増大させます。
質の高いドキュメントを作成する方法
すべての植物が、成長のために太陽の光を必要としています。そして幸運にも、太陽がなくなることはなく、いつも空に昇ってきてくれます。ドキュメントは太陽の光に似ていると言いましたが、太陽とは異なり、ドキュメントは積極的に作成し、維持するために労力をかける必要があります。
2021 年の State of DevOps Report で、今回の調査から得られたガイダンスとして、ドキュメントの品質を改善するために導入できる手法をご紹介しています。
今回の調査では個々のリソースについては掘り下げていませんが、有用なドキュメントを作成するうえで役立つリソースは数多くあります。社内にドキュメント作成ガイドラインやトレーニングが用意されている場合もあります。共同作業できるテクニカル ライターやその他のドキュメントの専門家がいるかもしれません。Google のドキュメント リソースには以下のようなものがあります。
ソフトウェア エンジニアのためのテクニカル ライティング コース
Software Engineering at Google のドキュメントに関する章
職場に品質の高いドキュメントが豊富にあるという恵まれた環境にある方は、ご自身や他の担当者が優れたコンテンツを作成したということです。しかし、ドキュメントの品質が低い組織でも問題はありません。先ほどご紹介したリンクの手法を導入すれば、ドキュメントの品質を改善し、その本分を発揮させることができます。
貴社のドキュメントの品質やその他の DevOps 手法について、2023 年の Accelerate State of DevOps アンケートでぜひお知らせください。アンケートの所要時間はわずか 15 分ほどで、2023 年 6 月 30 日深夜 0 時（太平洋夏時間）まで回答を受け付けています。
- ユーザー エクスペリエンス リサーチャー Derek DeBellis
