連載
» 2009年07月31日 00時00分 公開

開発工程でSEが書く文書の基本誰にでも分かるSEのための文章術(1)(2/2 ページ)

[谷口功,@IT]
前のページへ 1|2       

(3)外部設計書

 外部設計書は、外部設計の結果をまとめた設計書です。内部設計の基盤とするために作成します。設計者は、外部設計書に基づいて内部設計を行います。外部設計書には、システムが備えていなければならない機能やシステムの構造を記述します。この場合の「機能」とは、利用者が見ることができ、かつ把握できる機能です。

 また、システムで流通するデータについて記述します。システムで使われるデータの種類、システムに入力されるデータと入力方法、データの処理方法、データの保管場所と保管されるデータ、出力されるデータと出力方法などです。ユーザーインターフェイスについても記述します。画面操作方法、画面に表示する情報や帳票などです。

(4)内部設計書

 内部設計書は、内部設計の結果をまとめた設計書であり、プログラム設計の基盤とするために作成します。設計者は、内部設計書に基づいてプログラム設計を行います。

 内部設計書は、外部設計の段階で設計した機能やデータの流れをソフトウェアとしてどのように実現するかを設計した文書です。内部設計書には、求められる機能やデータの流通を実現するためのソフトウェアの動作や処理、ソフトウェアの構造、ソフトウェア間でのデータの受け渡しなどを記述します。

(5)プログラム設計書

 プログラム設計書は、プログラム設計の結果をまとめた設計書で、コーディングの基盤として作成します。プログラム設計書には、モジュールの処理内容や動作内容、入力データ、出力データ、データ・テーブルなどを記述します。

(6)テスト仕様書(テストケース)

 テスト仕様書は、どのようなテストを行うのかを規定する目的で作成します。なお、SEはシステムテストや運用テストを中心に、テスト仕様書を作成します。テスト仕様書は、システムの処理仕様や動作仕様をすべてカバーする網羅的なテスト項目をそろえ、1つ1つのテスト項目について、入力データとシステムの動作結果である出力データを記述します。

(7)マニュアル・説明書

 マニュアル・説明書の目的は、すべてのユーザーがシステムの使い方や操作方法を理解し、自力でシステムを使用できるようにすることです。同時に、すべてのユーザーが同じ方法、同じレベルでシステムを使用できるようにすることも目的とします。

 そのため、マニュアル・説明書は、システムを使用するために必要な指示を必要な順序で網羅したものでなければいけません。また、記述された手順や方法に従って操作すれば、誰でもシステムに仕事や処理を実行させることができるような内容、構成である必要があります。

提案書、要件定義書の難しさ

 提案書や要件定義書は、ITやシステム、コンピュータ、ネットワークなどの専門家ではない人を読み手とするため、作成に手を焼くSEが多いようです。読み手とは、顧客の経営陣、業務部門の管理職、実際にシステムを利用して業務を遂行するグループやチームのリーダー(管理者)などが含まれます。

 こうした人たちには、プログラムの注釈のような表現、SEやプログラマに向けた設計書のような表現、専門家向けの技術文書のような表現で書いた文書では通用しません。技術者同士だけで分かる表現ではなく、誰にでも伝わる表現で書くことが求められます。

 文書に盛り込まれた情報の質が優れていても、その表現が適切でなければ、読み手に分かってもらえませんし、信頼を得ることができません。上記のような読み手に分かってもらい、彼らからの信頼を得る文書にするためには、きちんとした表現技術が必要です。

 次回は、「提案書」「要件定義書」を書く際に必要なコミュニケーション能力について説明します。

著者紹介

谷口 功 (たにぐち いさお)

フリーランスのライター、翻訳家。企業にて、ファクシミリ通信網を使ったデータ通信システム、人工知能、日本語処理関連のソフトウェア開発、マニュアルの執筆などに関わる。退職後、コンピュータ、情報処理、通信関連の書籍の執筆、翻訳、各種マニュアルや各種教材の執筆に携わる。また、通信、コンピュータ関連のメールマガジンの記事、各種雑誌においてインターネット、パソコン関連の記事やコラムなども執筆。コンピュータや通信に関連する漫画の原作を執筆することもある。 主な著作は、『SEのための 図解の技術、文章の技術』(技術評論社)、『ソフト契約と見積りの基本がよ〜くわかる本』『よくわかる最新 通信の基本と仕組み』(秀和システム)、『図解 通信プロトコルのことがわかる本』『入門ビジュアルテクノロジー 通信プロトコルのしくみ』(日本実業出版社)、『図解 ネットワークセキュリティ』『マスタリングTCP/IP IPsec編』[共著](オーム社)など。



前のページへ 1|2       

Copyright © ITmedia, Inc. All Rights Reserved.

RSSについて

アイティメディアIDについて

メールマガジン登録

@ITのメールマガジンは、 もちろん、すべて無料です。ぜひメールマガジンをご購読ください。