サービス

ジャンル

職種：エンジニア

職種：ビジネス職

職種：デザイナー

職種：バックオフィス

職種：その他職種

技術

<p>この記事は、DMM グループ Advent Calendar 2023 の初日の記事です。執筆を担当しているのは、動画配信開発部で Web フロントエンド開発をしている大原一浩 (<a href="https://github.com/kazuhe" target="_blank">@kazuhe</a>) です。</p>

<p>世のソフトウェア開発において、「ドキュメント管理は難しい」という声をよく聞きます。この記事では、なぜドキュメント管理は難しいのかを考え、私たちはどのように解決しようとしているのかを書きたいと思います。一つの意見として見ていただけると幸いです。</p>

<h2>ドキュメントは何を達成しようとしているのか</h2>

<p>ソフトウェア開発においてドキュメントは、そもそも何を達成するために書くのでしょうか。プロジェクトの規模や開発のフェーズによって違いはあっても、以下のような目的があるかと思います。</p>

<ul>
	<li>システムの概要や構造を理解したい
	<ul>
		<li>例: アーキテクチャ図、データベース設計、API 仕様書、画面仕様書など</li>
	</ul>
	</li>
	<li>コードの詳細を理解し、追加修正を簡単にしたい
	<ul>
		<li>例: 関数やモジュールの説明など</li>
	</ul>
	</li>
	<li>ソフトウェアの品質を保証したい
	<ul>
		<li>例: テスト計画、テストケース、テスト結果の記録など</li>
	</ul>
	</li>
	<li>プロジェクトを円滑に進めたい
	<ul>
		<li>例: タスク管理方法、リリースフロー、リリース計画、オンボーディング資料、MTG 議事録など</li>
	</ul>
	</li>
	<li>ソフトウェアを適切に使用させたい
	<ul>
		<li>例: インストール手順、操作方法、トラブルシューティング情報など</li>
	</ul>
	</li>
</ul>

<p>この他にもたくさんあると思いますが、大小さまざまな目的を達成するためにドキュメントは書かれており、目的ごとに読む人や書く人、また内容も異なります。</p>

<p>さらに、これらのドキュメントは共通して情報が新しいこと、検索しやすいことが期待されます。せっかくあるドキュメントも古く誤った情報であれば意味はなく、むしろ目的達成の逆効果になってしまうこともあります。また、ドキュメントの量が増え意図した情報を検索することが難しくなると、当然目的は達成されません。</p>

<h2>なぜドキュメント管理は難しいのか</h2>

<p>先に述べたように、我々はさまざまな目的を達成するために、さまざまなドキュメントを大量に書きます。にも関わらず、情報の鮮度を保ちながら、検索が簡単に行えるように文書を構造化して整理しなければなりません。これが難しいとされる多くの理由だと考えます。</p>

<p>このドキュメント管理の「難しさ」を少なくするためにはどのように管理するとよいのでしょうか。全てを完璧に管理しようとせず、以下のことを意識するとよいと考えます。</p>

<ul>
	<li>情報の鮮度を保つドキュメントを限定する</li>
	<li>対象の性質に合わせてドキュメントを管理する</li>
</ul>

<p>それぞれについて、もう少し詳しく書きます。</p>

<h2>情報の鮮度を保つドキュメントを限定する</h2>

<p>情報の鮮度を保つドキュメントを限定する理由は、読み手が古くなった情報を誤って認識してしまうことを避けるためです。</p>

<p>何度も述べているように、大量にあるドキュメントを全て最新に保つことは非常に難しいです。であれば、せめて古い情報であることを読み手が理解できていれば、古い情報として参考にするだけで最新情報だと誤認するリスクは減らせます。よくストック情報とフロー情報を分けて管理する手法が紹介されていますが、鮮度を保つドキュメント = ストック情報と考えています。</p>

<h2>対象の性質に合わせてドキュメントを管理する</h2>

<p>素直に考えると、ドキュメントは同じような手続で管理する方が簡単に思えます。極端な例ですが、必ず変更の際にはメンバーのレビューが必要とルールを決めておくなどです。この例のように、多種多様な目的を達成するためのドキュメントを同じように管理すると、管理方法が複雑だった場合は当然ドキュメントの量が増えるにつれて大変になります。</p>

<p>大きな組織では特に、読み手の部署や職種によって閲覧できる (したい) ドキュメントは異なるので、(人によっては当然であると感じることかもしれませんが) 対象の性質に合わせたドキュメント管理を行うべきだと考えます。ただ、ここで注意するべきことは、管理する方法やツールが増えてくると、どこで何がどのように管理されているのか分からなくなります。これを解決するために、プロジェクト単位で最初に読むべき README 的なドキュメントを用意しておき、そこにドキュメント管理ルールが明確に記載されている必要があります。</p>

<h2>具体的な例</h2>

<p>とあるサービスのリニューアルプロジェクトを下図のような体制で行っています。この図の線はレポート先を表しており、2023年10月時点の大まかな体制です。</p>

<figure class="image"><img alt="2023年10月時点の大まかな体制図" height="154" src="https://image.dmm-corp.com/0wc25x59okpifqrhus4x6gymk29w" width="800" />
<figcaption>2023 年 10 月時点の大まかな体制図</figcaption>
</figure>

<p>この図の<em><strong> Web フロントエンド開発</strong></em> に関するドキュメント管理方法を紹介したいと思います。これが正解であるとは思っていないですが、一つの例として見ていただけると幸いです。また、これより以下では、Webフロントエンド開発に関わる開発者を <em><strong>FE 開発者</strong></em> と呼びます。</p>

<h3>管理する場所</h3>

<p>同じツールでドキュメント管理をすることが理想でしたが、社内事情で主に二箇所に分けることになりました。ただし、下図のようにツールの使い分けが明確になっていれば、思ったほど苦労せずにドキュメント管理ができています。</p>

<figure class="image"><img alt="" height="237" src="https://image.dmm-corp.com/hz4ai53abg25hbqhs86xug031gx9" width="800" />
<figcaption>ドキュメント管理場所を判断するためのフロー</figcaption>
</figure>

<p>FE 開発者以外も読むドキュメントは、社内で広く利用されている Confluence で管理しています。</p>

<p>FE 開発者しか見ないドキュメントについては、ほぼ全て GitHub で管理しています。この時、高い鮮度で保つドキュメントはドキュメント用の専用リポジトリを用意して、<a href="https://github.com/facebook/docusaurus" target="_blank">Docusaurus</a>で管理しています。このリポジトリだけ、継続的にメンテナンスを必要としており、その他のドキュメントは全てスナップショット (ある日時の状態を記録したもの) として扱います。これによって、開発が進み全体のドキュメント量が増加しても、最新に保つべきドキュメントは少なく、読み手が古くなった情報を誤って認識する可能性が低くなると期待しています。</p>

<p>また、上図はドキュメントの README 的な場所に記載し、各ツールのリンクを一覧にしています。</p>

<h3>管理方法</h3>

<p>管理する場所ごとに、管理する方法が異なります。これらの管理方法は、各場所の README に記載されています。</p>

<h4>Confluence</h4>

<p>ここには、Webフロントエンド開発者以外も閲覧するようなドキュメントを置いています。プロジェクト固有の情報を多く含むので詳細に書けないのですが、以下のように分けられています。</p>

<ul>
	<li>スペース XX はリニューアルプロジェクトに関するドキュメント
	<ul>
		<li>システムの要件や Web フロントエンドに閉じない仕様書など</li>
	</ul>
	</li>
	<li>スペース YY は FE開発者が所属するグループに関するドキュメント
	<ul>
		<li>FE開発者の紹介や関わっているプロジェクトの紹介など</li>
	</ul>
	</li>
</ul>

<h4>GitHub / ドキュメント用リポジトリ</h4>

<p>このリポジトリは可能な限り簡単に更新できることが理想なので、レビューは不要としています。書き手が変更の PR (Pull request) を作成し、 main へマージすると変更内容が Slack に通知されるので、間違った変更が行われた場合や、最新の情報を他のメンバーも把握することができます。</p>

<p>また、このリポジトリが大きくなればなるほど管理が大変になるので、本当に鮮度を高く保つべき情報かを考慮したうえで追加修正することをルールとしています。</p>

<h4>GitHub / Issue (ADR)</h4>

<p>ADR 自体の説明については、他にもよくまとまった記事が多くあるので、ここでは省略します。</p>

<p>継続してメンテナンスをする必要はないものの、極めて重要な意思決定で一度決定すると変更することが大きなコストになるものは、 Issue ラベル <em><strong>ADR</strong></em> を付与し、他 Issue とは異なる特別な方法で管理しています。具体的には、モジュールの責務配置や、ライブラリやフレームワークの決定が対象となり、以下のフローで管理運用しています。</p>

<figure class="image"><img alt="" height="562" src="https://image.dmm-corp.com/f9uqi3u3d8l5yx62il4v8twekmkx" width="455" />
<figcaption>ADR 運用フロー</figcaption>
</figure>

<p>例えば、新しく状態管理ライブラリを導入したいとなったとき、以下の添付画像のような Issue を作成し、チームメンバーに対して ADR を起票したことを伝えます。</p>

<figure class="image"><img alt="ADR Issue の例" height="450" src="https://image.dmm-corp.com/iitz2icrufbnra1loli4nsjb5j2b" width="800" />
<figcaption>ADR Issue の例</figcaption>
</figure>

<p>必要であれば、事前にメンバーの意見などを拾っておき、その後正式な提案を Issue のコメントに残します。</p>

<figure class="image"><img alt="" height="450" src="https://image.dmm-corp.com/jza29aurimba6udr0x61hley6o5j" width="800" />
<figcaption>ADR Issue の例</figcaption>
</figure>

<p>何か意見や質問があれば、Issue のコメントを追加してもらい、Issue 上で議論をします。口頭で議論した場合は、その内容を Issue コメントに残す努力をしています。このように時系列でコメントを残しておくことで、価値のある ADR になると思っています。</p>

<p>現時点ではチームメンバー全員の承認を必要としており、承認されると Issue 最上部のコメントの <em><strong>結果</strong></em> に、採用されたコメントのリンクを貼ります。その後、簡単に検索できるようにアプリケーションコードを管理するリポジトリの README にリンクを貼り、Issue を Close します。</p>

<figure class="image"><img alt="" height="450" src="https://image.dmm-corp.com/7adiqj7chguncyryadqqheq6jqes" width="800" />
<figcaption>READEME.md</figcaption>
</figure>

<p>まだ期間は短いですが、ADR を実際に運用してみて、既存の決定を変更する際の判断材料として役に立ちました。また、チームメンバーや新規参画者、マネージャーからも、どのような観点で意思決定されたか把握できるとの理由から高評価で、議論するコストはあるものの継続していきたいと思っています。</p>

<h4>GitHub / Issue or PR</h4>

<p>今までに登場していないほとんどのドキュメントは Issue または PR に書きます。</p>

<p>Issue は上流からの要求やリニューアル対象となるページを単位とした Epic と、FE開発者目線での作業を単位とした Task という概念に大別しています。この時、Task は必ず任意の Epic を 一つ持つルールとなっており、例として下図のような関係となります (執筆時では、GitHub Issue は子 Issue をタスクとして指定 (例: - [ ] #123) することで Issue の関連付けが可能です)。</p>

<figure class="image"><img alt="" height="130" src="https://image.dmm-corp.com/a6n5icn1e2o9ny22ayikuk0w817t" width="800" />
<figcaption>Epic と Task の関係図</figcaption>
</figure>

<p>このようにしておくことで、例えばトップページのテストに関連するドキュメントを探したいとき、Epic Issue 「トップページリニューアル」から該当のドキュメントを辿れるので検索が簡単です。</p>

<p>Task Issue で管理しているドキュメントの具体的な例として、以下のようなページの設計・テストケースを記したドキュメントなどがあります。</p>

<figure class="image"><img alt="" height="450" src="https://image.dmm-corp.com/b9mf4r1v5ydxwglzbpoxdw0t0uqs" width="800" />
<figcaption>Task Issue の例</figcaption>
</figure>

<figure class="image"><img alt="" height="450" src="https://image.dmm-corp.com/5128p5d8kjl9gupihaim18xjr95j" width="800" />
<figcaption>Task Issue の例</figcaption>
</figure>

<p>GitHub は <a href="https://github.com/mermaid-js/mermaid" target="_blank">Mermaid</a>&nbsp;を使うことができるので、Issue や PR でもある程度の表現をすることができます。</p>

<h2>最後に</h2>

<p>最後にこの記事の振り返りです。</p>

<ol>
	<li>ソフトウェア開発において、ドキュメントは何を達成しようとしているのか</li>
	<li>ドキュメントが達成したいことしたいことはたくさんある</li>
	<li>さらに、目的を達成するためには情報が新しいこと、検索しやすいことが期待されている</li>
	<li>これが難しいとされる多くの理由かもしれない</li>
	<li>では、以下を意識して管理してみるとよいかもしれない
	<ol>
		<li>情報の鮮度を保つドキュメントを限定する</li>
		<li>対象の性質に合わせてドキュメントを管理する</li>
	</ol>
	</li>
	<li>1 つの手法として ADR や Issue の種別定義をして楽な管理を目指す</li>
</ol>

<p>ドキュメントが難しいとされる理由を考えるところから、一例の紹介までを書きました。ドキュメント管理に正解はないと思うので、その場その時の状況に合わせて改善をしながら、目的達成のためにドキュメントを効果的に活用していきたいと思います。最後まで読んでいただきありがとうございました。</p>

<h2>宣伝</h2>

<p>社内事情で今回はプロジェクトの詳細を紹介することができなかったのですが、カジュアル面談ではもう少し詳細にお伝えすることができます。ご興味がある方はよろしければご応募ください。</p>


なぜソフトウェア開発のドキュメント管理は難しいのか

シェア

一緒に働く仲間を募集しています！

関連する求人

関連する記事