運用中のウェブアプリケーションの仕様書作成に必要な項目を教えてください。

今まで会社のITの担当者にウェブのアプリケーションの作成と運用をお願いしていました。
・担当者が急遽退社することになった。
・引き継ぎの人が入社するまで遺留しましたが無理とのこと。
・したがって、引き継ぎの人が入社したときに、ウェブのアプリケーションが理解できるような書類をのこして欲しいとお願いしました
・あまりやりたくないけど、言われたことは書きますとのこと。
そこで、何を書類として残せば良いかわかりません。本人に聞いても、言われたことはやる。の一点張り。
なにを書かせればよいでしょうか?

回答の条件
  • URL必須
  • 1人2回まで
  • 13歳以上
  • 登録:2011/01/19 06:03:29
  • 終了:2011/01/19 22:23:23

回答(2件)

id:deflation No.1

deflation回答回数1036ベストアンサー獲得回数1262011/01/19 07:14:12

ポイント40pt

どのような機能・規模のシステム化分かりませんが、一般論として、Webアプリなら以下のようなドキュメントが用意されます。

もし自分が引き継ぐ立場だったら、とくに★印のドキュメントが必須です。


  1. 要件定義書
    1. システム化目的方針(★)
    2. 要求機能一覧
    3. 検討課題一覧
    4. 課題・新要件の一覧
    5. 業務機能マトリクス(★)
    6. 方式設計基本要件(★)
    7. 新業務定義
    8. 概念モデル
      1. 概念エンティティ一覧
      2. 分析クラス図
      3. 分析パッケージ図
      4. ER図(★)
      5. エンティティ一覧(★)
      6. エンティティ定義(★)
      7. ドメイン定義
      8. 単語辞書
    9. 入出力概念設計
      1. 画面一覧(★)
      2. 帳票一覧(★)
      3. ファイル一覧(IF)(★)
      4. 画面フロー概要(★)
      5. 画面概要
      6. 帳票概要
    10. システム機能定義
      1. 機能一覧(★)
      2. 処理概要(★)
    11. セッション課題一覧
    12. 非機能要求一覧(★)
    13. テスト計画書(★)
    14. 方針設計書
      1. 実施処理方式
      2. システムプラットフォーム構成(★)
      3. 運用方式(★)
      4. システム運用範囲(★)
      5. セキュリティ実現方式(★)
      6. 処理分散設計
      7. システム開発標準(★)
      8. 開発環境とツール(★)
      9. 環境設計(★)
      10. 災害対策処理方式(★)
      11. 開発計画書(★)
  1. 外部設計(概要設計書)
    1. 機能概要
      1. 機能一覧(機能名)
      2. 機能概要
    2. 機能詳細
      1. 外部IF概要(★)
      2. IF名称(★)
      3. IF概要説明(★)
    3. 画面説明書
      1. 画面遷移図(★)
      2. 画面一覧(★)
      3. 画面名(★)
      4. 画面概要(★)
      5. 画面機能仕様(★)
    4. 帳票設計
      1. 帳票一覧(★)
      2. 帳票仕様(★)
      3. 帳票項目定義(★)
    5. イメージ設計
      1. イメージ一覧
      2. イメージ定義
    6. メッセージ一覧(★)
    7. DBアクセス条件定義
      1. CRDUマトリックス(★)
      2. オンラインメニュー体系一覧
      3. データ項目一覧(★)
      4. 環境設計書
    8. 新業務定義書
      1. 新業務フロー(プロセス定義版)一覧(★)
      2. 新業務フロー(プロセス定義版)(★)
      3. アクセス権限一覧(★)
      4. ワークフロー設計書
    9. ハードウェア、ソフトウェア設定書(★)
    10. 結合テスト計画書(★)
    11. 運用設計書(★)
    12. フレームワーク設計書(★)
    13. 基盤テスト計画書(★)
  1. 内部設計
    1. 機能設計
      1. 機能一覧(★)
      2. 機能詳細
    2. プログラム関連図
    3. プログラム一覧(★)
    4. プログラム処理概要
    5. IF設計書(★)
    6. ファイル設計書(★)
    7. コンポーネント設計書
    8. バッチJOB設計書(★)
    9. 画面設計
      1. 画面一覧(テーブル設計)
      2. 画面仕様
    10. 帳票設計
      1. 帳票一覧
      2. 帳票仕様
      3. 帳票レイアウト
      4. メッセージ一覧
    11. DB物理設計書
      1. ER図(★)
      2. 表定義(★)
      3. 索引定義(★)
    12. 業務運用設計書(★)
    13. 環境設計書(★)
    14. DBアクセス条件定義(★)
    15. ハードウェア・ソフトウェア設定書
    16. 単体テスト計画書(★)
    17. 結合テスト計画書(★)
    18. 運用ツール設計書
    19. システム間インターフェース設計書(★)
    20. サブシステム間インターフェース設計書(★)
  1. パフォーマンスチューニング
  2. 負荷テスト(★)
  1. 内部設計
    1. プログラム関連図
    2. IO関連図(DFD)
    3. 処理フローチャート
    4. ファイル仕様書
    5. 共通関数設計書(★)
    6. コンポーネント一覧(★)
    7. 画面設計
    8. 帳票設計
    9. メッセージ設計(★)
    10. 設定ファイル(★)

参考「即活用!業務システムの開発ドキュメント標準化

id:yo-jiro-11

ありがとうございます。大変参考になりました。

2011/01/19 22:20:26
id:windofjuly No.2

うぃんど回答回数2625ベストアンサー獲得回数11492011/01/19 11:16:08

ポイント35pt

【1】最優先事項

(1)使用しているソフトの一覧

(2)各ソフトのライセンスキーと有効期限

  気にせず使っている人も多いのですが、これは意外に重要

(3)各ソフトのアカウント名とパスワードの一覧

  いわずもがなですね。前任者が何も言わずにやめたために困っている人はよく見かけます

上記3点が揃っていれば何とかなりますが、揃っていないとどうしようもなく面倒なことになります

 

【2】優先事項

(1)概要書/仕様書

  Webアプリケーションとやらで、どのようなことを行っているかを数ページの書類にあらわしたもの

(2)外部設計書

  おおまかに、どのような機能を持っているかをあらわしたもの

  アプリケーションの内容や規模によって数ページから数十ページに及ぶものもあり

(3)詳細設計書(データベース設計書)

  トランザクションの範囲や、テーブルの連携、ならびにテーブルに入れる項目の詳細など

  テーブル1つにつき1ページから数ページであらわしたもの

これらがあるかないかで、引き継いだ者の仕事量は大きく変わります

無い場合で、かつ、引き継いだ者がよほどの技量を持っていない場合にはブラックボックスのままで運用される恐れもあり、その場合には多大な損失や損害を出す可能性まであります

 

【3】出来る限り欲しい資料

(1)詳細設計書(プログラム設計書)

  各プログラムが何を行っているかをあらわしたもの

  プログラムファイル1つにつき1ページから数ページになる場合もある

(2)日々の運用管理やメンテナンスで苦労させられる点

  運用環境や、利用者のスキル/性格によるところも大きいのでこれは正直には書きづらい部分もあります(苦笑)

 

【4】最悪、無くても良いもの

(1)一般ユーザー向けの操作説明書

  運用中ということですから、これは無くてもなんとかなる場合も多いです

 

やめる時のことまで考えている社員はまずいませんし、管理者がいなければ上記のようなものもゼロから作ることになるやもしれませんので、指示はお早めに

 

参考URLはありません。ダミーです

http://q.hatena.ne.jp/answer

id:yo-jiro-11

ありがとうございます。大変参考になりました。

2011/01/19 22:20:35
  • id:ken3memo
    個人的な意見・提案です。
    次の担当者のレベルにもよりますが、1日3万、3日間、時間を取れないか?丁寧に説得してみては?(それが無理だから はてなで質問している と 怒られそうですが)

    まぁ、関係がこじれて、書くものは書くと言っているのだから どんな項目を書かせれば良いかの質問ですが、
    変な意味、この状態でどんな項目を書かせても意味ある成果物にはなりそうもなかったり。(※やめて行く人の責任感、人間性にもよりますが)

    私もたまにそんなシステムの改修をやってますが、
    ・成果物はページと項目がそろっているだけで中身はボロボロ(だって中身を知っているのが辞めていく本人だから確認しようがなかった)
    ・最悪なのがソースにパスワードがかかっていたり、DBの管理者IDがわからなかったり
    なんてことが 現実にあるので(ウソのようなホントの話で事実は小説よりも...)
    最低限 パスワードの管理、引き継ぎは必要かなぁ。

    別方面からうまくアプローチして引き継ぎの期間を作れるといいのですが。
    以上、別角度 たまに仕様書無しのヤバイ仕事をしている三流プログラマーの独り言でした。
    ※うまく解決されることを願いつつ、失礼します。
  • id:windofjuly
    うぃんど 2011/01/19 23:15:31
    担当者に対して、システム開発を心得ている人が指示を出していたならば、開発に際してまずは設計書を要求しますが、エンドユーザーが指示を出していた場合はとにかく動く画面を要求し、ドキュメントの重要性など知ったものではないという状況であったと考えるに難くありませんが、yo-jiro-11 さんのお勤め(もしくは経営?)の会社ではどうだったのでしょうか

    担当者が辞めると言い出しただけであたふたすることになっているという現状からも、担当者に対して一方通行な指示や要求を出し続け、あるいは押し付け続けていたということも想像に難くありませんが、いかがだったのでしょうか
     
    一部上場の大企業での大規模開発であれば、ドキュメントも充実していますが、中小規模の開発会社では星マークのような資料すべてを揃えている予算など正直ありはしませんので、エンドユーザーの担当者レベルにあれだけのものを要求するのは酷であり、担当者の立場にたてば「私、堪忍袋の緒が切れました。今すぐ辞めさせていただきます」と言い出したくもなろうというものです
     
    やってみれば判ると思いますが、回答1のようなものを要求した場合には相手の顔色が変わるはずです。その場合は、このページを印刷したものを見せてみてください
  • id:sayo212sayo
    コメント荒らし キタ━━(━(━(-( ( (゚∀゚) ) )-)━)━) ━━ !!!!!
     
    他人の回答にケチを付けることを得意とする粘着厨
    以前から「コメント欄を開く設定しておくことを強くお勧めします」と
    繰り返し書いていたのは、コメント荒らしへの布石だったか!

この質問への反応(ブックマークコメント)

「あの人に答えてほしい」「この質問はあの人が答えられそう」というときに、回答リクエストを送ってみてましょう。

これ以上回答リクエストを送信することはできません。制限について

絞り込み :
はてなココの「ともだち」を表示します。
回答リクエストを送信したユーザーはいません