“何が非自明な要点なのかというのは全然基準がないのですが、プログラムの設計についてチーム内でチャットが盛り上がった場合、そのレスの応酬の果ての結論はドキュメントする価値があることが多いです。なぜなら非
どういうものかにも依るけど、外部インターフェース仕様書は丁寧だととても嬉しいッピ。機能仕様もそうだけど、機能の目的があるともっと嬉しいッピ。 (APIでもコマレスでもボタン仕様でも)
外部公開されてるSaaSのAPI定義書でさえ、書かれてない仕様があるもんな。 APIでは設定できないがAPI定義項目から、自動で算出される値とか、nullの時の挙動とか。 資料づくり難しい。
さすがkumagiさん! いい本を推薦されますね。
どんなドキュメントかどうかより、「誰が何のために読むことを想定したものか」が明確になってるほうが重要。そういう決まりだから、以上の理由がないなら書かないほうがマシ、と思う。
そうじゃなくて、ドキュメントは人に伝えるもの。対象には将来の自分も含む。また、ドキュメントを書くほど検証しなければならない。V字モデルってやつ。その基本を踏まえてこそドキュメンテーションの議論が可能。
ガチガチに作っておかないと後で誤解を生むし、コード読めない人が中身レビューしたり運営したりすることもあるので絶対に必要なのよ。それがないと修正を委託したりもできないしね
ちょっとしたツールなんかを展開してみて、ドキュメント無しでどこまでやれるかチャレンジしてみるといい。コードは想像以上に人の手を渡り魔改造される
ドキュメントは大事なんだけど、詳細に作るほどソースコードと一対一に近づいていきソースコード見ればいいじゃない?となるし、メンテナンスが二重になるので更新が放置/遅れがち。更新されない文書はむしろ足枷。
必要なのは entity の集約(Aggregation root)同士の関連図で、集約さえわかれば要素や時間的存在はそこから引っ張ってこれる。のだが私以外に Aggregation を重視する人を見たことがない。DDD論者?あいつらVOの話しかしないだろ
SIerに入社してしまった人間には全く参考にならないアドバイスかもしれん。違う業種なんで、下手に参考にすると疎まれてしまう。とはいえSIerでも粒度は大事でさ、細かすぎると手間ばかり増えて不正確になるし。
IPAに全体が俯瞰できる資料+サンプルがあったはず。追記)これだったかなぁ... https://www.ipa.go.jp/archive/digital/tools/ep/ep2.html
「アホでも理解可能度」をどれだけ突き詰めるか、だな。デカいプロジェクトほどこの水準は低くなりアホみたいなドキュメントを書く羽目になる。そしてVibeコーディングで全人類が逃れられなくなった
普通、といわれるとな。。SIerでも全然違うので何とも。おそらく正しいものも効率的なものもないと思う。大規模システム開発ではガチガチに作成せざる得ず、それを延々と繰り返して今になってる。歴史の積み重ね
エクセル地獄にゃんて、ボクには無理だにゃ!モフモフ癒やしで解決にゃ!
インタフェースとかはないと連携出来んからな。何がいるの、と、何を出すの、は最低限。基本設計書は、他の設計書へのリンクとか概略図が載ってる認識。
今年4月からソフトウェアエンジニアとして働き始めたものです。 くまぎさんの会社ではソフトウェア開発でコード以外にはどういったものをアウトプットしていますか? 配属された部署では設計/テスト関連では基本設計書、詳細設計書、単体試験項目書、結合試験項目書などなどをエクセル等でガチガチに作成しており非常に驚きました。 学生時代はそこまでしっかりとしたドキュメントを作成して開発したことはなく、どういったものが普通なのか、効率的なのか気になった次第です。 | mond
“何が非自明な要点なのかというのは全然基準がないのですが、プログラムの設計についてチーム内でチャットが盛り上がった場合、そのレスの応酬の果ての結論はドキュメントする価値があることが多いです。なぜなら非
どういうものかにも依るけど、外部インターフェース仕様書は丁寧だととても嬉しいッピ。機能仕様もそうだけど、機能の目的があるともっと嬉しいッピ。 (APIでもコマレスでもボタン仕様でも)
外部公開されてるSaaSのAPI定義書でさえ、書かれてない仕様があるもんな。 APIでは設定できないがAPI定義項目から、自動で算出される値とか、nullの時の挙動とか。 資料づくり難しい。
さすがkumagiさん! いい本を推薦されますね。
どんなドキュメントかどうかより、「誰が何のために読むことを想定したものか」が明確になってるほうが重要。そういう決まりだから、以上の理由がないなら書かないほうがマシ、と思う。
そうじゃなくて、ドキュメントは人に伝えるもの。対象には将来の自分も含む。また、ドキュメントを書くほど検証しなければならない。V字モデルってやつ。その基本を踏まえてこそドキュメンテーションの議論が可能。
ガチガチに作っておかないと後で誤解を生むし、コード読めない人が中身レビューしたり運営したりすることもあるので絶対に必要なのよ。それがないと修正を委託したりもできないしね
ちょっとしたツールなんかを展開してみて、ドキュメント無しでどこまでやれるかチャレンジしてみるといい。コードは想像以上に人の手を渡り魔改造される
ドキュメントは大事なんだけど、詳細に作るほどソースコードと一対一に近づいていきソースコード見ればいいじゃない?となるし、メンテナンスが二重になるので更新が放置/遅れがち。更新されない文書はむしろ足枷。
必要なのは entity の集約(Aggregation root)同士の関連図で、集約さえわかれば要素や時間的存在はそこから引っ張ってこれる。のだが私以外に Aggregation を重視する人を見たことがない。DDD論者?あいつらVOの話しかしないだろ
SIerに入社してしまった人間には全く参考にならないアドバイスかもしれん。違う業種なんで、下手に参考にすると疎まれてしまう。とはいえSIerでも粒度は大事でさ、細かすぎると手間ばかり増えて不正確になるし。
IPAに全体が俯瞰できる資料+サンプルがあったはず。追記)これだったかなぁ... https://www.ipa.go.jp/archive/digital/tools/ep/ep2.html
「アホでも理解可能度」をどれだけ突き詰めるか、だな。デカいプロジェクトほどこの水準は低くなりアホみたいなドキュメントを書く羽目になる。そしてVibeコーディングで全人類が逃れられなくなった
普通、といわれるとな。。SIerでも全然違うので何とも。おそらく正しいものも効率的なものもないと思う。大規模システム開発ではガチガチに作成せざる得ず、それを延々と繰り返して今になってる。歴史の積み重ね
エクセル地獄にゃんて、ボクには無理だにゃ!モフモフ癒やしで解決にゃ!
インタフェースとかはないと連携出来んからな。何がいるの、と、何を出すの、は最低限。基本設計書は、他の設計書へのリンクとか概略図が載ってる認識。