19章ドキュメント作成業務の改善:エンジニアリングワークフローへのドキュメンテーションの統合

Ríona MacNamara、Shylaja Nukala、

協力:Stas Miasnikoŭ、Aaron Gillies、Jeremy Sharpe(以上Google)、Niall Richard Murphy(Microsoft)

ソフトウェア業界では全体的に、エンジニアリングドキュメンテーションに対する信頼感が低いものです。Stack Overflowが2016年に実施した開発者調査(https://insights.stackoverflow.com/survey/2016#work-challenges-at-work)では、開発者が直面する課題の第2位がドキュメンテーションでした。

これは問題です。欠落がある、不完全、陳腐化している、不正確といったドキュメンテーションは、開発のスピード、ソフトウェアの品質、そして(SREにとって特に重要な)サービスの信頼性に悪影響を及ぼします。また、そのために生じるフラストレーションは、開発者が仕事に不満を持つ最大の原因(https://arxiv.org/pdf/1703.04993.pdf)になりかねません。

ドキュメンテーションには時間も労力もかかり、特にSREにとっては難しい課題です。SREは一般に35%の時間を運用業務に費やすため、開発向けに残るのは65%しかありません。ドキュメンテーションに費やす時間は開発予算から捻出する必要がありますが、ドキュメントの作成や保守はつまらない仕事で、人事考課や昇進のプロセスでも評価されず報われないという意識がある場合には、予算すなわち時間の確保が難しくなります。

こうした状況はどうすれば変えられるでしょうか。組織がエンジニアリングドキュメンテーションの価値を理解し、ドキュメントの作成と保守をエンジニアに奨励し、その励行が評価、資金提供、報酬に値する活動であることを経営層や管理層に納得させるには、どうすればよいのでしょうか。 ...

Get SREの探求 ―様々な企業におけるサイトリライアビリティエンジニアリングの導入と実践 now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.