• はてなブックマーク
  • テクノロジー
  • 今年４月からソフトウェアエンジニアとして働き始めたものです。 くまぎさんの会社ではソフトウェア開発でコード以外にはどういったものをアウトプットしていますか？ 配属された部署では設計/テスト関連では基本設計書、詳細設計書、単体試験項目書、結合試験項目書などなどをエクセル等でガチガチに作成しており非常に驚きました。 学生時代はそこまでしっかりとしたドキュメントを作成して開発したことはなく、どういったものが普通なのか、効率的なのか気になった次第です。 | mond
  • Twitterでシェア
  • Facebookでシェア

今年４月からソフトウェアエンジニアとして働き始めたものです。 くまぎさんの会社ではソフトウェア開発でコード以外にはどういったものをアウトプットしていますか？ 配属された部署では設計/テスト関連では基本設計書、詳細設計書、単体試験項目書、結合試験項目書などなどをエクセル等でガチガチに作成しており非常に驚きました。 学生時代はそこまでしっかりとしたドキュメントを作成して開発したことはなく、どういったものが普通なのか、効率的なのか気になった次第です。 | mond

テクノロジー カテゴリーの変更を依頼 記事元:mond.how
適切な情報に変更
203users がブックマーク コメント 27
    共有

    • 記事へのコメント27件

    • 注目コメント
    • 新着コメント
    その他
    Palantir
    どういうものかにも依るけど、外部インターフェース仕様書は丁寧だととても嬉しいッピ。機能仕様もそうだけど、機能の目的があるともっと嬉しいッピ。 (APIでもコマレスでもボタン仕様でも)

    その他
    dot
    ドキュメントは大事なんだけど、詳細に作るほどソースコードと一対一に近づいていきソースコード見ればいいじゃない？となるし、メンテナンスが二重になるので更新が放置/遅れがち。更新されない文書はむしろ足枷。

    その他
    virgospica
    そのドキュメントは誰に向けて書いてますか？自社のプロダクトで一緒に作業する人のためのドキュメントと、SIerがIT詳しくないお客さんのためのドキュメントでは必要なことが全然違う

    その他
    hogetax
    IPAに全体が俯瞰できる資料＋サンプルがあったはず。追記）これだったかなぁ... https://www.ipa.go.jp/archive/digital/tools/ep/ep2.html

    その他
    cinq_na
    SIerに入社してしまった人間には全く参考にならないアドバイスかもしれん。違う業種なんで、下手に参考にすると疎まれてしまう。とはいえSIerでも粒度は大事でさ、細かすぎると手間ばかり増えて不正確になるし。

    その他
    iksmpic
    ガチガチに作っておかないと後で誤解を生むし、コード読めない人が中身レビューしたり運営したりすることもあるので絶対に必要なのよ。それがないと修正を委託したりもできないしね

    その他
    Xibalba
    “何が非自明な要点なのかというのは全然基準がないのですが、プログラムの設計についてチーム内でチャットが盛り上がった場合、そのレスの応酬の果ての結論はドキュメントする価値があることが多いです。なぜなら非

    その他
    pmint
    そうじゃなくて、ドキュメントは人に伝えるもの。対象には将来の自分も含む。また、ドキュメントを書くほど検証しなければならない。V字モデルってやつ。その基本を踏まえてこそドキュメンテーションの議論が可能。

    その他
    magi00
    これって見積もりに乗せるための証拠づくりだったりしないかな。“配属された部署では設計/テスト関連では基本設計書、詳細設計書、単体試験項目書、結合試験項目書などなど”

    その他
    pixmap
    どんなドキュメントかどうかより、「誰が何のために読むことを想定したものか」が明確になってるほうが重要。そういう決まりだから、以上の理由がないなら書かないほうがマシ、と思う。

    その他
    tamanecoplus
    しかも試験項目書はバグを多く出した方が品質が上がるという謎文化

    その他
    rrringress
    誰に何を残したいか（裏返すと読み手の問いが大事）

    その他
    hitanaka
    後で、絶対に、読みます！

    その他
    eos2323
    組織ごとにテンプレはあれど、とりあえずお盆明けに30分でコールドスタートできるような資料は欲しいわ。ガチガチのやつは数年後に別の人が読んで理解するための資料

    その他
    magi00
    magi00 これって見積もりに乗せるための証拠づくりだったりしないかな。“配属された部署では設計/テスト関連では基本設計書、詳細設計書、単体試験項目書、結合試験項目書などなど”

    2025/08/03 リンク

    その他
    aaaa_a4
    昨日、コードが仕様って言われとこだっピ。

    その他
    junglejungle
    ISO遵守、何かあった時に責任回避する為だけの誰も読まないドキュメント量産してます。非効率だよな。

    その他
    szsszs
    とりあえずデータベースとapiがガチガチに設計できてると安心する。その設計に至るための要件も。

    その他
    shQ_Ch
    開発大好き！全部自分の頭の中にあるから資料化するのはめんどくさい！けど数ヶ月後に忘れてるから自分のためにも重要なとこだけでもメモしときたい派

    その他
    number917
    グーグル社員の回答だと参考にできない人のが多いやろ

    その他
    inks
    全ての基本は日本語から。理系の人間が避けがち。

    その他
    virgospica
    virgospica そのドキュメントは誰に向けて書いてますか？自社のプロダクトで一緒に作業する人のためのドキュメントと、SIerがIT詳しくないお客さんのためのドキュメントでは必要なことが全然違う

    2025/08/03 リンク

    その他
    houyhnhm
    インタフェースとかはないと連携出来んからな。何がいるの、と、何を出すの、は最低限。基本設計書は、他の設計書へのリンクとか概略図が載ってる認識。

    その他
    FreeCatWork
    エクセル地獄にゃんて、ボクには無理だにゃ！モフモフ癒やしで解決にゃ！

    その他
    toro-chan
    普通、といわれるとな。。SIerでも全然違うので何とも。おそらく正しいものも効率的なものもないと思う。大規模システム開発ではガチガチに作成せざる得ず、それを延々と繰り返して今になってる。歴史の積み重ね

    その他
    mole-studio
    「アホでも理解可能度」をどれだけ突き詰めるか、だな。デカいプロジェクトほどこの水準は低くなりアホみたいなドキュメントを書く羽目になる。そしてVibeコーディングで全人類が逃れられなくなった

    その他
    hogetax
    hogetax IPAに全体が俯瞰できる資料＋サンプルがあったはず。追記）これだったかなぁ... https://www.ipa.go.jp/archive/digital/tools/ep/ep2.html

    2025/08/03 リンク

    その他
    cinq_na
    cinq_na SIerに入社してしまった人間には全く参考にならないアドバイスかもしれん。違う業種なんで、下手に参考にすると疎まれてしまう。とはいえSIerでも粒度は大事でさ、細かすぎると手間ばかり増えて不正確になるし。

    2025/08/02 リンク

    その他
    turanukimaru
    必要なのは entity の集約（Aggregation root）同士の関連図で、集約さえわかれば要素や時間的存在はそこから引っ張ってこれる。のだが私以外に Aggregation を重視する人を見たことがない。DDD論者？あいつらVOの話しかしないだろ

    その他
    dot
    dot ドキュメントは大事なんだけど、詳細に作るほどソースコードと一対一に近づいていきソースコード見ればいいじゃない？となるし、メンテナンスが二重になるので更新が放置/遅れがち。更新されない文書はむしろ足枷。

    2025/08/02 リンク

    その他
    iksmpic
    iksmpic ガチガチに作っておかないと後で誤解を生むし、コード読めない人が中身レビューしたり運営したりすることもあるので絶対に必要なのよ。それがないと修正を委託したりもできないしね

    2025/08/02 リンク

    その他
    pmint
    pmint そうじゃなくて、ドキュメントは人に伝えるもの。対象には将来の自分も含む。また、ドキュメントを書くほど検証しなければならない。V字モデルってやつ。その基本を踏まえてこそドキュメンテーションの議論が可能。

    2025/08/02 リンク

    その他
    pixmap
    pixmap どんなドキュメントかどうかより、「誰が何のために読むことを想定したものか」が明確になってるほうが重要。そういう決まりだから、以上の理由がないなら書かないほうがマシ、と思う。

    2025/08/02 リンク

    その他
    takebe51
    さすがkumagiさん! いい本を推薦されますね。

    その他
    Eiichiro
    外部公開されてるSaaSのAPI定義書でさえ、書かれてない仕様があるもんな。 APIでは設定できないがAPI定義項目から、自動で算出される値とか、nullの時の挙動とか。 資料づくり難しい。

    その他
    Palantir
    Palantir どういうものかにも依るけど、外部インターフェース仕様書は丁寧だととても嬉しいッピ。機能仕様もそうだけど、機能の目的があるともっと嬉しいッピ。 (APIでもコマレスでもボタン仕様でも)

    2025/08/02 リンク

    その他
    Xibalba
    Xibalba “何が非自明な要点なのかというのは全然基準がないのですが、プログラムの設計についてチーム内でチャットが盛り上がった場合、そのレスの応酬の果ての結論はドキュメントする価値があることが多いです。なぜなら非

    2025/08/02 リンク

    その他

    注目コメント算出アルゴリズムの一部にLINEヤフー株式会社の「建設的コメント順位付けモデルAPI」を使用しています

    アプリのスクリーンショット
    いまの話題をアプリでチェック！
    • バナー広告なし
    • ミュート機能あり
    • ダークモード搭載
    アプリをダウンロード

    関連記事

    今年４月からソフトウェアエンジニアとして働き始めたものです。 くまぎさんの会社ではソフトウェア開発でコード以外にはどういったものをアウトプットしていますか？ 配属された部署では設計/テスト関連では基本設計書、詳細設計書、単体試験項目書、結合試験項目書などなどをエクセル等でガチガチに作成しており非常に驚きました。 学生時代はそこまでしっかりとしたドキュメントを作成して開発したことはなく、どういったものが普通なのか、効率的なのか気になった次第です。 | mond

    今年４月からソフトウェアエンジニアとして働き始めたものです。 くまぎさんの会社ではソフトウェア開発...

    ブックマークしたユーザー

    すべてのユーザーの
    詳細を表示します

    同じサイトの新着

    同じサイトの新着をもっと読む

    いま人気の記事

    いま人気の記事をもっと読む

    いま人気の記事 - テクノロジー

    いま人気の記事 - テクノロジーをもっと読む

    新着記事 - テクノロジー

    新着記事 - テクノロジーをもっと読む

    同時期にブックマークされた記事

    いま人気の記事 - 企業メディア

    企業メディアをもっと読む

    はてなブックマーク

    公式Twitter

    はてなのサービス

    • App Storeからダウンロード
    • Google Playで手に入れよう
    Copyright © 2005-2026 Hatena. All Rights Reserved.