人力検索はてな
モバイル版を表示しています。PC版はこちら
i-mobile

開発会社さんにWebシステムを開発して貰っていますが、色々な経緯からマニュアル以外のドキュメントが一切ないシステムを引き継ぎ、現在ディレクションを行っています。

システム利用者の修正要望をつどつどベースでなんとか対応したのですが、次年度以降の事を考えると仕様書ベースでの開発にしたいと考えております。

開発会社さんに依頼すれば仕様書の類は書き起こしてくれそうなのですが、私の業界経験年数が低く、どういったドキュメントを依頼すればいいのか判りません。

そこで、主にプロマネやSEの皆さんに質問です。

大体の開発規模が1000万円程度(それなりのベンダーさんだと億単位になると先輩には言われている)予約システム(社内外、業者などアクター複数)をあなたが引き継ぐ場合、どのようなドキュメントがあれば「じゃぁ引き継げそうだな」という言葉を自信を持って発する事が出来ますか?

システムの詳細については説明できませんが、あくまで一般的に必要とされるドキュメントを教えて下さい。
その際、参考資料となるURLも付けていただけると嬉しいです。

●質問者: schahrazade
●カテゴリ:インターネット ウェブ制作
✍キーワード:SE URL Web あなた アクター
○ 状態 :終了
└ 回答数 : 4/4件

▽最新の回答へ

1 ● huruyosi
●23ポイント

http://www.atmarkit.co.jp/bbs/phpBB/viewtopic.php?topic=22248&am...

ここでいうところの「要件定義書」は必須。基本設計書はあれば、尚、良し。

詳細設計書と基本設計書はソース類から書き起こすことはできますが、要件定義書に込められたお客さんの想いを行間から読むのは大変ですからね。また、潜在バグがあり、仕様を誤認する可能性もあります。

◎質問者からの返答

コメントありがとうございます。

システム開発の経緯はともかく、やっぱりこちら側で要件定義書を作成する必要はありますよね。

やった事がない作業なのでちょっと苦手意識がありますが、RFPの本を買ってきて勉強しようと思います。


2 ● tomo_k
●23ポイント

外部設計的なところで

・画面遷移図・画面設計書(ボタンを押したらどういう動きをするなどを記述)

内部的なところで

・DB設計書(これはツールがあれば自動生成可能ですね。OracleだったらObject browser等)

・クラス設計書・内部設計書(JavaあたりではJavaDocが詳しく記述されていれば代用になるかと思います)

とまあ、小手先の対応でよければこの程度でも何とかなります。

一番重要なのはやはり内部設計書でこれと実際のソースコードを見てどこに変更が入りそうなのか当たりをつけることができます。

クラス一覧のような物を作ってクラスの継承関係や簡単な説明をつける。

クラス個別に定数値やクラス変数、メソッドなどの説明をつける。メソッドは引数・戻り値・処理の流れの説明は最低限必要。

DB設計書はテーブルごとの想定件数を書いておくとSQL文の最適化に役立つかもしれません。

あとは、概要設計書的なもので対象業務の流れを説明した物があると仕様変更の際に背景を知ることができよりよい提案ができるかもしれません。

◎質問者からの返答

コメントありがとうございます。

画面遷移図や画面設計書、DB設計書は本当に欲しいです。

これがない為に、頭の中にエアーシステムを作って対応していたので、やっぱり欲しいですね。

クラスに関しては、そういう感じの綺麗なコーディングではないと思われるので、今回は見送ろうかと思っています。


3 ● samasuya
●22ポイント

・ER図

・クラス図

・ソース

が最低あれば、なんとかなると思います。

特にDBは、テーブルとその列が何のためにつかわれているか

わからないと、怖くて更新すらできません。

ソースがあれば、なんとか解読できると思いますが、

クラス図は、漏れがないかをチェックするために使えば

いいじゃないでしょうか?

あとは、ユースケース図、シーケンス図があれば、

なおよしって感じですね。

サーバーが別々なのであれば、インフラ関連の設定書は、

欲しいところです。


昔、javaのclassファイルしかない業務を引き継ぎましたが

上記があれば、なんとか対応した覚えがあります。

◎質問者からの返答

DBの指摘はまさにその通りで、現時点では開発会社にお任せな感じです。ここの整備は急務ですね・・・。

シーケンス図はシステムの概要を部長に報告する時に作成しました。(かなりうそ臭い図でしたが)

ユースケース図までは落とし込む時間がなかった、というよりかは事業部の意向でいきなり仕様が変わっていくので書くのを断念したという感じです。

インフラ関連の設定書(設計書?)は是非欲しいですね。

ちなみにシステムの開発はPHPで行われているようです。


4 ● KUROX
●22ポイント

基本設計書は必ずあるはずです。これは最低限いります。

これがなくてつくることはありえません。

http://www.thinkit.co.jp/free/project/4/3/1.html

DB設計書でも、きちんとその項目の意味とか使用目的が

書いてないのはNGです。

>クラスに関しては、そういう感じの綺麗なコーディングで

>はないと思われるので、今回は見送ろうかと思っています。

あと、細かいプログラムは諦めるとして、

フレームワークとかそういうブラックボックスになる要素を

つかってるのなら、システム構造がわかる資料がないと

ソース解読は難しいかもしれません。

方式設計というか構造設計書みたいなもの。

例:strutsをつかってるとか・・。

---------

Javaなら、JavaDOCがきちんとできてるのなら良いですが。

◎質問者からの返答

>基本設計書は必ずあるはずです。これは最低限いります。

>これがなくてつくることはありえません。

開発会社の規模が10名以下なのですが、やっぱりこういうドキュメントは持っているものなのでしょうか?

以前、はてなの伊藤さんの講演を聞いた時に、はてなのサービスには仕様書がないという事を聞いたのですが、「あるある」と思った私は育ち方を間違えたのでしょうかorz

フレームワークは恐らく使っていないと思います。

関連質問


●質問をもっと探す●



0.人力検索はてなトップ
8.このページを友達に紹介
9.このページの先頭へ
対応機種一覧
お問い合わせ
ヘルプ/お知らせ
ログイン
無料ユーザー登録
はてなトップ