設計ドキュメント特集を企画した意図（Software Design 2024年10月号）

はじめに

私は2023年4月から『Software Design』の編集長をしています。これまで特集や記事の企画意図などについて発信するときは、X（旧Twitter）の@gihyosdアカウントで投稿していたのですが、2024年10月号（9月18日発売）の「再考 設計ドキュメントの課題」特集の話は少し長文になりそうでした。また、本特集に対する読者の注目度も高そうでした。以前から「一度、ブログでSoftware Designに関わる情報を発信してみたい」と思っていたため、ちょうどよい機会と思い、筆をとりました。

ドキュメント問題はIT業界共通の悩みだが……

日本のIT業界では、よくドキュメントの是非について話題にあがります。数週間前にはXで、「コードの1行1行に対応する処理内容を文章で記述するようなプログラム詳細設計書は必要か？」という議論が盛り上がっているのを見かけました。このプログラム詳細設計書は極端な例かもしれませんが、そこまででなくとも「コードと同じようなことをドキュメントに書かないといけない。しかも、コードの変更に応じて最新化していかないといけない」という二重管理問題は典型的なドキュメントの悩みかと思います。そして、結局「コードの変更に応じて、きちんとドキュメントを更新できていない。結果的に情報の古い、使えないドキュメントになっている」という陳腐化問題に発展していることもよくあります。

編集者の職に就く前の私はSIerでSEとして働いており、ドキュメントの作成やメンテナンスの苦労は自ら経験したので、ドキュメントに関する問題はある程度理解しているつもりです。IT業界の多くの人が共有する悩みであることはわかっていましたが、あまりにも泥臭く、華やかさに欠けるため、今までは雑誌記事の企画として、ドキュメントの課題について真剣に検討したことはありませんでした。

米国のドキュメント事情を知ったのが企画のきっかけ

しかし、次の牛尾剛さんのブログを読み、やりようによっては特集として成り立つのではないかと感じました。

アメリカの職場ではなぜドキュメントも無いのに人が去っても問題ないのだろう？

このブログを読んだとき、最初に思ったことは、「ここに書かれているような『ドキュメントも無いのに人が去っても問題ない』というような状況は、日本では実現できないのだろうか？」ということでした。

ブログに書かれているような状況は（前述のドキュメント問題が発生しないという意味で）国内のITエンジニアにとっても理想像と言えそうです。もし同じ状況を実現できる方法があるなら紹介する意義は十分にあります。そんな想いから「記事として成り立つか、ちょっと調べてみよう」と動き出したのでした。

それで、「ドキュメントを作らない開発」は、日本でも実現できるのでしょうか？

結論は特集を読んでいただくとわかるのですが、日本でも実現できます（※1）。実際に、自社開発、受託開発、どちらのケースでもドキュメントを（極力）作らない開発を実現している事例があります。本特集では、それぞれのケースの企業に自社の取り組みを紹介してもらっています。

※1　ただし、開発するソフトウェア、開発規模、開発手法、ステークホルダーなど事情はそれぞれなので、すべての企業や現場ができるというわけではありません。

理想だけでなく、現実的な話も

さて、そんな「ドキュメントを作らない開発」のような理想像を追う気持ちがありつつも、一方では、さまざまな理由からドキュメントを作らざるを得ない企業や現場もあるだろう、とも思っていました。むしろ、日本でドキュメントに悩んでいる現場は、このような自社（自分たち）だけの努力だけではどうにもできないケースが多そうです。そういう事例も取り上げないと、実用的な特集にはなりません。そこで、ドキュメントをなくせないなら、ドキュメントにまつわる悩みを少しでも減らすためのヒントやアイデアも紹介したいと考えました。

今回の特集では、冒頭に挙げたようなドキュメントの二重管理や陳腐化の問題の解決に、技術と工夫で前向きに取り組んでいる企業の事例も紹介しています。日本ではこちらの事例のほうが「ドキュメントを作らない開発」よりも現実的な解決案だ、と感じる方々も多いかもしれません。

ドキュメントの話題はまだありそう

このような経緯で、みなさんの課題解決の糸口や発想の転換になるように、初の設計ドキュメント特集をまとめました。しかし、まだまだ語れていないこともあるのではないかとも感じています。

特集を読んで、今回取り上げられていない問題点や、違う切り口の課題解決のアイデアなどがあれば、ぜひ編集部（※2）にお寄せいただければと思います。第2弾の設計ドキュメント特集につながるかもしれません。

※2　ちょっとした感想やご意見は読者アンケートから、自社事例を記事として書けるよというご提案はメール（sd@gihyo.co.jp）から、お声をお寄せください。