3-10 「システムの動作・機能」を表す際の留意事項
サーバやプログラムコンポーネントなどの動作あるいは機能を文で表さなくてはならない場合があります。
例1 情報通信システムでのサーバやクライアントなどの動作
例2 機器に実装された組込みシステムでのプログラムコンポーネントの動作
例3 サービスや関数などのプログラムコンポーネントの機能
エンドユーザーに向けたマニュアルであってもプログラマに向けたプログラム開発ガイドであっても、「事物」である製品の動作あるいは機能を表す際には共通の原則があります。
原則1 事物の内容、動作、作用、状態などを表す際は、必ず主語を明示する。
原則2 事物の内容、動作、作用、状態などは、「省略された主語」の対象となる人称の「視点」で表す。
原則3 事物を主語にした際は、「行う」、「使う」などの行為を表す述語を控える。
原則4 事物を主語にした際は、「《動詞》できる」などの可能表現を控える。
原則5 事物を対象にした使役表現「せる/させる」を控える。
エンドユーザー向けとプログラム開発者向けとで特に違いが現れるのは、上記の原則2の省略された主語の対象となる人称の「視点」で表すという点です。視点が変われば製品の動作の表し方も変わります。
今回は、プログラム開発者向け仕様書でプログラムコンポーネントの動作・機能を表す際の原則と留意事項を解説します。エンドユーザー向けの製品解説での製品の動作・機能の表し方は、別の回で解説します。
1.
エンドユーザー向けとプログラム開発者向けでの文体の違い
2.
「動作の主体になる語」と「動作の主体にならない語/なりにくい語」
3.
「主語の省略」に関する原則
4.
陥りやすい事例:「動作の主体」の欠落
5.
「どこに/何に」および「どのような条件で」に関する原則
6.
陥りやすい事例:「どこに/何に」が欠落した「提供する」
7.
「述語」に関する原則
8.
陥りやすい事例:述語に用いる語のゆれ
9.
陥りやすい事例:行為と動作の混在
10. 陥りやすい事例:機能の「能力」扱い
まとめ
後 記
© Yamanouchi Takaaki 2024
[注]今回のテーマは他の回と関わる部分が多いため、以前に解説した内容と重複する箇所があります。
ブログの本文は、下記のPDFファイルで閲覧できます。
本文のPDFファイル(A4判・全25ページ)
【重要】 PDFファイルの表示に伴うトラブルへの責任は、一切負いません。
ブログではタイトルを開いたページに本文を表すのが普通ですが、あえてワープロで作成した本文をPDFファイルにして概要・目次に添付しました。HTML形式ではワープロ文書の表し方を解説しきれないというのがその理由です。
l PDFファイルは、5MB以内です。使用する閲覧ソフトウェアによって表示の細部が若干異なる場合があります。
l PDFファイルの利用は、閲覧のみです。共有やダウンロードなどのご要望には応じかねます。
コメント
コメントを投稿