Comments
Description
Transcript
エディションとネイサン
THE ELEMENTS OF TECHNICAL WRITING by Gary Blake and Robert W. Bly Published by Longman Publishers. 1185 6th Avenue, New York, NY 10036 Copyright © 1993 by Gary Blake and Robert W. Bly All rights reserved. Authorised translation from the English languages edition published by Longman Publishers. No part of this book may be reprinted or reproduced or utilised in any form or by any electronic, mechanical, or other means, now known or hereafter invented, including photocopying and recording, or in any information storage or retrieval system, without permission in writing from the publishers. Translation copyright © 2011 by Maruzen Publishing Co., Ltd., Tokyo. Japanese translation rights arranged with Pearson Education, Inc., publishing as Longman through Japan UNI Agency, Inc., Tokyo. Printed in Japan 原書まえがき 1981 年 に 私 た ち は， 『Technical Writing: Structure, Standards, and Style』 という本を上梓し，これが私たちの処女作となった．最初に契約を結んだエイ ジェントが間をとりもってくれ，原稿を最初に目にしてくれた出版社が出版を引 き受けてくれた． 私たちも，そしてエイジェントも出版社も，この本はそこそこ売れるだろうと は思っていたが，でも，まさか，10 年で 10 刷もされるとは誰も思っていなかっ た． 『Technical Writing: Structure, Standards, and Style』が刊行された後，私た ちは，それぞれ自分の仕事に戻ったのであるが，仕事をしながらも，テクニカ ル・ライターが書いたメモやマニュアルといったものをいろいろと調べたりして いた．そして今回，こうやって調べて得た知識を公開できるチャンスを得ること ができたのである．つまり，変わりゆくテクニカル・ライティングを紹介でき る，そんな本を今回こうやって刊行することができたのである． 今回，出版社を新たにして，本書『The Elements of Technical Writing』を 上梓することができたわけだが（ちなみにエイジェントは前作の『Technical Writing: Structure, Standards, and Style』を出したときと同じである） ，本書 を執筆するにあたって，多くの人からいろいろコメントをいただき，それがとて も役に立った．コメントを寄せてくださった方のバックグラウンドはさまざまで あり，少しピックアップするだけでも，製造業，航空宇宙産業，電気通信，電子 工学，食品産業，廃棄物処理，銀行，保険，化学処理産業，IT 関係，ソフトウェ ア，法律，医療，ケーブルテレビといったものを挙げることができる． 本書をお読みいただければ，産業界ならびにテクノロジーの世界における大き な変化が，いい感じで捉えられているのがわかっていただけるのではないかと 思っている． 私たちの最初の本が出てからいろいろ調べてきたこともあり，情報科学や情報 工学に見られるライティングの特徴といったものを今ではハッキリと言うことが できると自負している．私たちは，とにかく，情報系の人がよく犯すパンクチュ エイション （句読法）の問題とはいかなるものであるかをつきとめ，そして，シス The Elements of Technical Writing iv テム解析をする人やシステム・エンジニアが書くマニュアルにはどういった特徴 があるのか明確にするよう努めた． さらに，技術系のものに関しては，定義にせよテクニカル・ライティングの特 徴にせよ，さらには，本書で紹介している例から説明文に至るまで，かなり練り 上げて書いたつもりである．そして，そうすることにより，書いてあることがよ り読者にストレートに伝わるように，さらには，書いてある内容も信頼性の高い ものになるようにした．このように，本文を何度も書き直すことにより，私たち の考えもどんどん洗練されていくことになったのだが，そのおかげで，1990 年 代後半以降の科学技術の動向に焦点を当てることができた． では，以下に，本書の構成をかいつまんで紹介する． 1 章では，テクニカル・ライティングに必要な 10 項目を紹介する．これらの いくつかは，他の一般的なライティングにもいえることではある．が，この章で 紹介されるサンプルや解説を見ていただければわかるように，これら 10 項目は， やはり，テクニカル・ライティングに特徴的であることがわかることであろう． 2 章では，数や単位，それに数式や記号の正しい使い方について解説する．こ れさえマスターしておけば，数式を書く上で，何か困るということはまずないで あろう． 3 章では，文法の基本的なことについて解説する．とはいうものの，科学論文 でよく見かける文法的な誤りに焦点を置いている． 4 章では，テクニカル・ライティングの鉄則といったものを紹介する．具体的 には，科学論文で求められるトーンやスタイル，それにことば遣いといったもの を紹介する． 5 章では，ジャーゴン（テクニカルターム（専門用語） ）や手垢のついた表現，そ れに古くさい表現といったものについて考察する．そして，こういった NG ワー ドを使わないようにするにはどうしたらいいのかについて考える． 6 章では，手紙やメモを書くにあたり，どういったフォーマットで書いたらよ いか，そして，ことば遣いやあいさつはどうしたらいいのかについて解説する． 今日では，科学技術の分野において，マニュアルはとても重要な位置を占める ようになってきている．そこで 7 章では，マニュアルについて論ずることにす る． このところ，新技術の開発により，遺伝子やデータ通信，それにコンピュー タ・テクノロジーや医学，さらにはエネルギー開発やエコロジーといった分野に The Elements of Technical Writing 原 書 ま え が き v おいて目覚ましい発展が見られる．この勢いはこれからも続いていくであろう し，そしてそれにともない，サイエンスの世界では新しい研究分野がどんどん開 拓されていくことであろう．さらに，これまで以上にクリアーで簡潔な，そして 正確なテクニカル・ライティングが求められていくであろう． お読みいただけるとわかるように，本書は知りたいことがすぐにわかるように 書かれているし，さらに，読んでいてワクワクするように書かれている．私たち は，本書を執筆するにあたり，とにかく簡潔に，しかもヴィヴィッドに，さらに はポイントをしっかり押さえて書くよう心がけた． そうはいうものの，今こうやって「まえがき」を書いていても，いろんな思い が頭の中を駆けめぐる．例えば，本書が単なる作文指南書になってしまってはい ないだろうかとか，皆さんの専門分野の例がちゃんと取り入れられているだろう かとか，固くなく砕けすぎずいい感じで書かれているかとか……．何はともあ れ，簡潔に書くのがベストである．ということで，グダグダ書くのはこのぐらい にして，このあたりでペンを置くことにする． The Elements of Technical Writing 謝 辞 本書を書いたのはたしかに私たち 2 人ではあるが，いろいろな人たちの助け があったからこそ書くことができたのも，これまたたしかである．そのようなこ ともあり，執筆期間中にサポートをしてくださった方やアイデアを提供してくだ さった方，そして励ましのことばをかけてくださった方には心から感謝する次第 である． まず，Amy Bly 氏と Eve Blake 氏，それに Tim Yohn 氏と故 Jack Nathan 氏 に感謝申し上げる．システム解析について助言してくださった Richard Nelson 氏にも感謝したい． ま た， 出 版 エ イ ジ ェ ン ト の Dominick Abel 氏 と 編 集 担 当 者 の Natalie Chapman 氏にもいろいろとお世話になった．Strunk and White の本やクライ アントからもいろいろアイデアをもらった．当該の本ならびにクライアントにも 感謝のことばがない．さらに，本書を執筆するにあたり，いろいろとクライアン トと仕事をさせてもらったわけであるが，セミナーやライティング・プロジェク トや個人指導（チュートリアル） といったものを通して，エンジニアに関するサン プルやイラストといったものを入手させていただいた． The Elements of Technical Writing 目 次 1 「うまい！」と言われるテクニカル・ライティング 1 テクニカル・ライティングとは？ ･････････････････････････････････････････････････ 1 テクニカル・ライティングとそうでないもの ･････････････････････････････････ 2 いいテクニカル・ライティングとは…… ･････････････････････････････････････････ 3 1． テクニカル・ライティングは何よりも正確でないといけない ･･････････ 3 2． 読者が必要な情報のみ書くようにする ････････････････････････････････････ 4 3． テクニカル・ライティングはシンプルでかつクリアーでないとい けない ････････････････････････････････････････････････････････････････････････ 5 4． テクニカル・ライティングは完全かつ完璧でないといけない ･･････････ 8 5． テクニカル・ライティングはクリアーに書かれてないといけない ･････ 9 6． テクニカル・ライティングは首尾一貫していないといけない ･････････ 11 7． スペリングとパンクチュエイション，それに文法ミスには要注意 ････ 12 8． どんな人が読むのかイメージしながら書くようにしよう ･･････････････ 13 9． しっかりした構成のものを書くようにしよう ･･･････････････････････････ 18 10. どうせ書くなら興味をもってもらえるものを書くようにしよう ･･････ 21 2 数字に単位，それに式と記号の表し方 23 数 字･････････････････････････････････････････････････････････････････････････････ 24 規則 1 10 未満の数はすべてことばで書き表すようにする ････････････････ 24 規則 2 1 つのパッセージに，9 以下の数と 10 以上の数が混在する ときは，数字はどれもアラビア数字で書くようにする ････････････ 25 規則 3 大きな数は，読み手になじみがあり，なおかつ見てすぐ理解 できるような形で書かないといけない ･･････････････････････････････ 26 規則 4 数字と単位がいっしょになって，ある名詞を修飾していると きは，数字と単位の間にハイフンを入れるようにする ････････････ 29 規則 5 1 以下の数を表す分数なり小数が，ある名詞を修飾している The Elements of Technical Writing viii ときは，単複に関しては単数扱いする ･･････････････････････････････ 30 規則 6 小数と分数はことばではなくアラビア数字を使って書くよう にしよう ････････････････････････････････････････････････････････････････ 31 規則 7 小数を縦の列や横の列にリストアップするときは，特に，表 記を首尾一貫させるようにしよう 規則 8 ･･･････････････････････････････････ 32 精度が高いことをアピールせんがために，小数点以下にゴ チャゴチャと数字を並べ立てるようなことはしないようにし よう ･････････････････････････････････････････････････････････････････････ 34 規則 9 だいたいの数を言いたいのであれば，数字を使わずにことば で書き表すようにする ････････････････････････････････････････････････ 34 （通常短いほうであるが）1 つを 規則 10 数値が 2 つ連続するときは， ことばで書き表すようにする･････････････････････････････････････････ 36 規則 11 アラビア数字で文を書き始めてはいけない ･････････････････････････ 37 測量単位･････････････････････････････････････････････････････････････････････････････ 38 規則 12 単位はどんなものであれ首尾一貫して使わないといけない ･･･････ 38 規則 13 使う単位系を決めたのであれば，その単位系の単位を首尾一 貫して使うようにする ････････････････････････････････････････････････ 39 規則 14 基本単位はことばで書き表し，組立単位は記号で書き表すよ うにする ････････････････････････････････････････････････････････････････ 41 規則 15 組立単位を書くにあたっては，かけ算の記号は中黒（･）で表 し，割り算の記号はスラッシュ （/） で表すようにしよう ･･････････ 43 規則 16 別の単位系でも数値を紹介するのであれば，そのときはカッ コを使ってやるようにする ･･･････････････････････････････････････････ 43 数 式･････････････････････････････････････････････････････････････････････････････ 44 規則 17 数式は可能な限り使わないようにする ･･････････････････････････････ 45 規則 18 数式は，短くて簡単なものでない限り，センタリングした上 で改行し，さらに番号をつけて書くようにする ････････････････････ 46 規則 19 数式を書くにあたっては，等号や割り算，それに分数の記号， さらには，かけ算やプラス，それにマイナスの記号といったも のは，どれも，同じ高さに揃えて書くようにしよう･･･････････････ 47 規則 20 文中に数式が出てきても，いつもと同じように句読点をふる ようにする ･････････････････････････････････････････････････････････････ 48 The Elements of Technical Writing 目 次 ix 記 号･････････････････････････････････････････････････････････････････････････････ 50 規則 21 記号は使うにしてもあまり使いすぎないようにする･･･････････････ 50 規則 22 論文で使う記号はすべて定義するようにしよう ････････････････････ 52 規則 23 1 つの記号でいくつもの意味が表わせてしまうことがないよ うにしよう ･････････････････････････････････････････････････････････････ 53 規則 24 記号を使うにしても，地の文の中では文法に合う形で使うよ うにしよう ･････････････････････････････････････････････････････････････ 53 3 パンクチュエイションに文法，それに略語や大文字語といっ たものに役立つ規則 55 パンクチュエイション （句読法）･･･････････････････････････････････････････････････ 55 規則 25 複合語の形容詞をつくるにあたっては，2 つの語をハイフン で結ぶようにする･･････････････････････････････････････････････････････ 55 規則 26 2 つの名詞がいっしょになって 1 つの概念を表すのであれば， そのときは，その 2 つの名詞をハイフンで結ぶようにする ･･･････ 57 規則 27 いくつもの単語が等位接続されているときは，最後の単語を 除いてすべての単語の終わりにコンマを打つようにする ･････････ 58 規則 28 文の中にカッコつきで文が挿入されているとき，そのカッコ 内の文にはピリオドをつけない．ただし，文が単独でカッコ つきで紹介されているときはその限りではない ････････････････････ 59 文 法･････････････････････････････････････････････････････････････････････････････ 60 規則 29 分詞は懸垂させないようにする ･･････････････････････････････････････ 60 規則 30 無終止文は書いてはダメ ･･････････････････････････････････････････････ 61 規則 31 断片文は使わないようにする･････････････････････････････････････････ 62 略 語･････････････････････････････････････････････････････････････････････････････ 63 規則 32 略語は初出のときにスペルアウトする．ただ，略語は，使う にしてもあまり使いすぎないようにする････････････････････････････ 63 規則 33 略語ではピリオドは使わないようにする････････････････････････････ 66 規則 34 略語をつくるにあたり，元の語が大文字なら大文字で，小文 字なら小文字で書くようにする ･･････････････････････････････････････ 67 （イン 規則 35 ライティングをするにあたっては，表の中を除き，” The Elements of Technical Writing x チ）や ’ （フィート） といった記号は使わないようにする ･･････････ 68 大文字表記 ･･････････････････････････････････････････････････････････････････････････ 69 規則 36 商標名は大文字で書き始める･････････････････････････････････････････ 69 規則 37 目立たせたいがために単語を大文字で書き始めたりしてはな らない･･･････････････････････････････････････････････････････････････････ 71 規則 38 官庁の名称や企業の名称，それに部や課の名称，さらには他 の組織の名称といったものは，どれも大文字で書き始めるよ うにしよう ･････････････････････････････････････････････････････････････ 72 規則 39 固有名詞はどれも大文字で書き始めるようにする．ただし， あまりによく使われるようになり，大本の固有名詞（人名）が 意識されないようになったものはその限りでない ･･･････････････ 73 4 テクニカル・コミュニケーションをうまくやるコツ 75 規則 40 可能な限り能動態を使うようにする ･････････････････････････････････ 75 規則 41 コテコテした大袈裟なことばを使わず，あっさりしたスト レートなことばを使うようにする ･･･････････････････････････････････ 76 規則 42 なくてもいい語や文，それにフレーズはカットしてしまおう ････ 78 規則 43 漠然とした一般的なことばではなく，ハッキリとした具体的 なことばを使うようにしよう･････････････････････････････････････････ 80 規則 44 書いてあることが読み手の頭の中で具体的にイメージできる ようにする ･････････････････････････････････････････････････････････････ 83 規則 45 自分が行った実験や，その実験の結果は過去形で書く ････････････ 84 規則 46 自分が行った実験の報告以外は，ほとんどの場合において， 現在形を使って書くようにする ･･････････････････････････････････････ 84 規則 47 読み手の知識に応じ，テクニカルな内容のレベルを調整する ようにしよう ･･･････････････････････････････････････････････････････････ 85 規則 48 小分けにして書くようにする･････････････････････････････････････････ 87 規則 49 話の内容と文の構造はどちらもパラレルな形で書くようにし よう ･････････････････････････････････････････････････････ 87 規則 50 どちらかというと，フォーマルな書き方よりもインフォーマ ルな書き方のほうがいい ･･････････････････････････････････････････････ 89 The Elements of Technical Writing 目 次 xi 5 間違って使われることばとフレーズ 93 テクニカルなことばとジャーゴン ････････････････････････････････････････････････ 93 大袈裟な小難しいことば ･･････････････････････････････････････････････････････････ 95 グダグダした表現 ･･････････････････････････････････････････････････････････････････ 98 「馬から落馬した」表現 ･･･････････････････････････････････････････････････････････ 100 手垢のついた時代錯誤的な表現･･････････････････････････････････････････････････ 103 時代を感じさせる派手な言い回し ･･･････････････････････････････････････････････ 104 あれこれ使われる -ize････････････････････････････････････････････････････････････ 105 名詞の形容詞的用法･･･････････････････････････････････････････････････････････････ 107 間違って使われやすい単語や句･･････････････････････････････････････････････････ 108 ようするに，テクニカル・ライティングをするにあたっては……･･･････････ 114 6 手紙とメモ 117 手紙とメモをうまく書くコツ ････････････････････････････････････････････････････ 117 1． 可能であれば，相手の名前と役職名を書く ･････････････････････････････ 117 2． Re を使って用件を示す ･･･････････････････････････････････････････････････ 118 3． 何のために手紙なりメモを書いているのか，最初のパラグラフで 書くようにする ････････････････････････････････････････････････････････････ 119 4． 質問に答えるにあたっては，しかるべき順番で答えるようにする ･･･ 120 5． フォーマットを使うようにする ･･････････････････････････････････････････ 120 6． 手紙もメモも短いものにする ････････････････････････････････････････････ 126 7． 読み手が次にとるべき行動を書いた上で，手紙なりメモを締めく くるようにする ････････････････････････････････････････････････････････････ 127 8． 結語はシンプルなものにする ････････････････････････････････････････････ 127 9． 目に優しいフォーマットにする ･･････････････････････････････････････････ 128 電子メールについてちょっとだけ触れておこう ･･･････････････････････････････ 128 1． メッセージは短めにする･･････････････････････････････････････････････････ 128 2． 電子メールといえどもちゃんと書くようにする････････････････････････ 129 3． 即レスする前に一呼吸する ･･･････････････････････････････････････････････ 129 4． オリジナルのメッセージに言及しながら返信する ･････････････････････ 129 The Elements of Technical Writing xii 5．必要に応じて前のメールを言い換えるなり編集したりする ････････････ 129 7 マニュアルと添付書類 131 マニュアルにもいろいろある ････････････････････････････････････････････････････ 131 いいマニュアルを書くためのガイドライン･････････････････････････････････････ 133 1． マニュアルを書くというのは，読み手に指示を与えることである ･･･ 133 2． 書くべきことは 1 つ残らず書くようにする･････････････････････････････ 134 3． マニュアルはクリアーにかつ正確に書くようにしよう ････････････････ 136 4． 指示が確実に伝わるよう，誤解されない書き方をする ････････････････ 137 5． 警告をする ･････････････････････････････････････････････････････････････････ 138 6． 命令形で書く･･･････････････････････････････････････････････････････････････ 140 7． 読者層ならびに読み手の関心，そして書く内容に応じてマニュア ルの構成を考える ･････････････････････････････････････････････････････････ 142 8． 操作は通し番号をつけて提示してやる ･･････････････････････････････････ 145 9． モジュール・スタイルの構成にする･････････････････････････････････････ 146 10. マニュアルをテスト・ドライブする･････････････････････････････････････ 147 訳者あとがき ･････････････････････････････････････････････････････････････････････････ 149 索 引 ･･････････････････････････････････････････････････････････････････････････････ 152 The Elements of Technical Writing