技術系の資料に関わらず多くの文書では、導入部として「まえがき」があります。
通常、「まえがき」は章分けをしないで概論を述べる場合の方が多いです。論文であれば「まえがき」の章分けはご法度です。
ただ、ビジネス系の仕様書や報告書でしたら、以下に紹介するような定型の章立てを作ってしまうやり方もありです。別のドキュメントを作る時も、大枠のフォーマットさえ作っておけば後は細かい文言を書き換えるだけで済みますので便利です。
例えば以下のような定型を作ります。
- どんな読書を対象としているのか
- この文書における表記方法などのルール
- 関連文書
- この文書に関しての問い合わせ方法
「まえがき」の章立ては、例えば以下のようになります。
1. Preface 1.1. Intended audience 1.2. Conventions used in this document 1.3. Related documents 1.4. How to contact ABC※ |
1. まえがき 1.1. 対象とする読者 1.2. この文書における決まりごと 1.3. 関連文書 1.4. ABC社※とのコンタクト方法 |
---|
※書き手がABC社の社員であるという設定です。
対象とする読者(Intended audience)
この文書がどのような読み手向けに書かれているのかを明確にします。
This document is aimed for (読者1), (読者2), and (読者3).
この文書は、(読者1)、 (読者2) および (読者3)向けです。
この文書は、(読者1)、 (読者2) および (読者3)向けです。
ヒント
- aim for ~: ~をねらいとする
- (読者)には、the designer や the manager などが入ります。
この文書における決まり事(Conventions used in this document)
例えば、太字や斜体をどんな意味合いで使っているのか、単位系は何を用いているのかなどを記述します。
Emphasis: Italics are used to emphasize titles of documents, chapters and subsections, as well as important terms.
強調表現: 斜体は、文書、章 および 小章の題名や、重要な単語を強調するのに用いられている。
強調表現: 斜体は、文書、章 および 小章の題名や、重要な単語を強調するのに用いられている。
Measurements: All measurements are in the International System of Units.
測定値: 全ての測定値はSI単位系を用いています。
測定値: 全ての測定値はSI単位系を用いています。
関連文書(Related documents)
読み手が参照するかもしれない、または読み手に参照してほしい関連文書がある場合は、ここに記述します。
例えば、読み手がABC社のwebサイトから関連文書をダウンロードできるようになっている場合は、以下のような文書を入れて、その下の表にリストアップします。
The documents listed are available on the ABC web site.
リストになっている文書は、ABC社のウェブサイトから利用できます。
リストになっている文書は、ABC社のウェブサイトから利用できます。
関連文書の表の例
Document | Contents |
---|---|
関連文書1 |
関連文書1の説明文を入れる。例えば、 Gives an overview of … 訳)…の要旨を伝えます |
関連文書2 |
関連文書2の説明を入れる。例えば、 Explains how to … 訳)…する方法を説明しています |
… |
…. |
- Contentsの文章の主語は当然、Documentとなりますので、主語は通常省略します。よっていきなり動詞の大文字から文章がスタートします。
ABC社とのコンタクト方法(How to contact ABC)
この文書に関しての質問や要望に応えるため、いくつかの場面を想定してリストを作ります。
Here, you can find information on how to contact ABC in different situations.
以下、種々の場面においてABC社へ連絡するための方法に関する情報です。
以下、種々の場面においてABC社へ連絡するための方法に関する情報です。
連絡方法の表の例
To (to+不定詞)–> 目的 |
Refer to/contact 参照先/連絡先 |
---|---|
例1: Get support | support@ABC.com |
例2:Obtain information on … | ABC web site |
… | … |
この表は、実は文章になっています。例1の場合、
To get support, contact support@ABC.com
和訳) サポートを得るために、support@ABC.comに連絡してください。
ということになります。