タグ

2012年7月20日のブックマーク (2件)

  • 何のためにドキュメントを作成するのか - tomoyamkungの日記

    現在担当している案件の基設計書案(アウトライン)を作成してみたので上司に添削していただいたのだが、散々な結果に終わってしまった。 上司が言ったことと同じことを書いているサイトを見つけたので引用しておく。 しかし,型通りに作った設計書が,常に目的にかなった“正しいもの”であるとは限らない。一番怖いのは,「設計書は何のために存在しているのか」という点を設計者がうっかり忘れているか,そもそも意識していない場合である。 意図が伝わる設計書作成の心得【第1回】 | 日経 xTECH(クロステック) 設計書を作成する上で,標準化や定型化にとらわれ過ぎてしまうと,設計書を「何のために作るのか」という根的かつ重要な情報が抜け落ちやすくなる。「とりあえず標準に沿って作成すればよい」という設計者の態度は,後の工程でトラブルを生む原因になりかねない。 意図が伝わる設計書作成の心得【第1回】 | 日経 xTE

    何のためにドキュメントを作成するのか - tomoyamkungの日記
    kahki
    kahki 2012/07/20
  • 基本設計書のアウトライン(案) - tomoyamkungの日記

    今度こそ基設計書のアウトラインを作成してみた。今後また作成することもあるだろうからメモとして残しておく。 基設計書として以下の4ドキュメントを作成。 環境設計書:使用するサーバと構成について アプリケーション設計書:アプリケーション全体の設計、個々に切り出される機能について 開発手順書:開発手順、コーディングルールなど 運用設計書:運用全体の考え方、納品したお客さまが参照する操作マニュアル類 環境設計書 構成図:サーバの構成についての説明と図示(APサーバ、データベース、イメージ専用サーバ、(メールサーバ)) 使用ソフトウェア:OS、APサーバ、データベースの名称、バージョン、URLなど アプリケーション設計書 プロダクト構成:使用するフレームワークやライブラリについて 構成図:MVC2モデル図 プロダクト:DI、ORM、ajax、テストなどで使用するプロダクトの名称、バージョン、UR

    基本設計書のアウトライン(案) - tomoyamkungの日記
    kahki
    kahki 2012/07/20