システムエンジニアのドキュメント作成の見本となるもの

質問

システムエンジニアの方に質問があるのですが、
エンジニアをやるときに、当然、様々なフェーズでドキュメントを作成すると思います。

システムエンジニアの仕事の流れと、そのときに作成するドキュメントの作成例みたいな書籍があれば、お教え願えればと思います。

回答No.2

nakasako · ベストアンサー

SEです。

SEで取り扱うドキュメントって、時と場合で非常に多種多様です。それにNo.1の方が言うように客先からフォーマットなどを指定される場合もあるので、一概に「コレ」というのはありません。

まず、お客様の悩みを聞きながら整理するときは「要求仕様書」というのを作りますし、その要求を満たすシステムを提案するときには「提案書」を作ります。で、その提案書をベースにプレゼンするわけです。プレゼンのやり方やお客様の性質などを考慮してビジュアルに訴えたりもします。
その後、そのシステムが採用され、プロジェクトが立ち上がり、開発が始まれば、プロジェクトに必要なさまざまなドキュメントが必要になります。
お客様には最終的に要求仕様」や「提案書」に書いた内容のシステムがちゃんとできたことを証明するために「検査仕様書」「検査報告書」などを提出します。そのほかに、そのシステムを運用するのに必要な「運用マニュアル」なども提出します。
お客様によっては、システムを設計したときに作成した「外部設計書」「内部設計書」などをすべて提出するように要求してくる場合もあります。
内部設計書などはプログラマの方がさ作成する場合がほとんどですが、外部設計書などはSEと開発者とで常にお客様の要求にマッチするかを整合しながら作成します。
SEって、ようは何でも屋なんですよ。参考書はたくさんあります。たとえば、
　「SEを極める50の鉄則」(日経BP社）
　「SEの現場シリーズ」（翔泳社）
などを参考にされてはいかがでしょうか？

回答No.1

txrx

ドキュメントの提出先にあわせることが多いです。
ドキュメントは、提出先(クライアント)によって、書き方の流儀が異なります。
技術系のクライアントから受注するのであれば、そのクライアントにお手本を見せてもらう方が良いと思います。
一般的な流儀で書いても、クライアントが気に入らないと書き直したりして面倒ですよ。

私の経験では次のパターンが最も多いです。
・要求仕様書(クライアントが作成)
・仕様書
・設計書
　場合によっては、複数(概要→・・→詳細のように)
・テスト仕様書
　単体試験や結合試験、総合試験や運用試験等。
・テスト結果報告書

クライアントによって、内容の濃さが全く異なってきます。クライアントと話し合われた方が身のためです。