えっ、なになに?設計ドキュメント問題に関する特集だって?
— Junichi Ito (伊藤淳一) (@jnchito) 2024年9月3日
しかも「受託開発なのにドキュメントを書かずに済む秘訣」って、おい、マジかよ!そんなウマい話、あるわけないだろ!! #PR https://t.co/KZtN1o6Rqu
突然ですが、みなさんに質問です。
Q1. コードを書くのは好きですか? (Yes / No)
Q2. ドキュメントを書くのは好きですか? (Yes / No)
Q1の答えがYesで、Q2の答えがNoだったそこのあなた!(たぶん9割以上が該当するはず?)
とっておきの秘訣があります😎
お知らせ
というわけでお知らせです。
Software Design 2024年10月号の「再考 設計ドキュメントの課題」という特集で『「コードがドキュメント」を地で行く開発スタイル』という章を執筆させてもらいました。
このエントリではこの寄稿記事について簡単に紹介します。
「コードを書くのは好きだけど、ドキュメント作成は嫌い」というあなたに
まず、「再考 設計ドキュメントの課題」という特集記事の冒頭に書かれている、本特集のイントロダクションを引用します。
ITエンジニアにとってドキュメントは悩ましい問題です。関係者との合意形成や情報共有のために必要なものの、コードができあがってくると、コードと同期をとって保守しなければならない気が重い存在となります。
(略)
本特集では、いくつかの開発現場におけるドキュメントとの付き合い方を紹介します。ご自身の現場に合ったドキュメントとの付き合い方を見つけられるかもしれません。
いやあ、ほんとそうですよね〜。
なんでコードを書く前にいちいちドキュメントなんか書かなきゃいけないの!
さっさとコード書かせてよ!!
って思いますよね〜。
僕も前職や前々職ではそういう悩みを持ってました。
ですが、現職のソニックガーデンに入社してからはそういう悩みがなくなりました。
というか、ドキュメントを書かなくても済む理想的な開発プロセスがあったので、それを求めて僕はソニックガーデンに入社しました。
それから10年以上経ちましたが、やはりソニックガーデンではほとんどドキュメントを書いていません。
入社前は本当にそんなことできるの?と半信半疑な部分もありましたが、10年以上ドキュメントを書かずにここまで開発をやってこれました!
でも日本の開発の現場では、中でもとりわけ受託開発の現場では、やれ要件定義書だ、やれ外部設計書だ、詳細設計書だ、と「エンジニアなのにコードじゃなくてドキュメントばっかり書いてる……」というエンジニアが今でもたくさんいると思います。
そういったドキュメント作成が苦にならない人はそれで良いですが、僕みたいに「コードを書くのは大好きだけど、ドキュメント作成は大嫌いでござる!」という人はぜひ!本書を手に取り、『「コードがドキュメント」を地で行く開発スタイル』を読んでみてください。
そうすれば、ソニックガーデンではなぜドキュメントを作らないのか?なぜドキュメントを作らなくてもシステム開発できるのか?というあなたの疑問が解決するはずです!※
※ 注:ただし、弊社の開発スタイルをすぐにみなさんの現場に適用できるとは限りません。その理由も本記事を読めばわかるはずです。
おまけ
Rubyで型付け開発!?
Rubyにだって型はあるんだぞ!という話も載ってますw@gihyosd pic.twitter.com/p2fNp2r4Bb
— Junichi Ito (伊藤淳一) (@jnchito) 2024年9月17日
まとめ
というわけで、このエントリではSoftware Design 2024年10月号に寄稿した『「コードがドキュメント」を地で行く開発スタイル』という記事の紹介をしてみました。
Software Design 2024年10月号は本日(2024年9月18日)発売ですので、気になる方はぜひ、お近くの書店で手に取ってみてください😄
電子版もありますよ〜。
謝辞
Software Design誌に寄稿したこの記事は、僕が弊社ソニックガーデンのメンバーとディスカッションし、そこで挙がったさまざまな意見を記事としてまとめたものです。
「ソニックガーデンはなぜドキュメントを書かないのか」というテーマで一緒にワイガヤしながらその理由を深掘りしてくれた弊社メンバーに感謝します!
あわせて読みたい
Software Design誌の編集長(そして「プロを目指す人のためのRuby入門」の編集者でもある)、吉岡さんが書かれた「再考 設計ドキュメントの課題」という特集記事を企画した意図や背景が書かれたブログ記事です。
「編集者の職に就く前の私はSIerでSEとして働いており、ドキュメントの作成やメンテナンスの苦労は自ら経験した」とのことで、みんな悩みどころは同じなんですね。
Software Design 2024年10月号とあわせてこちらもぜひ!