わかりやすい技術文書へのアプローチ
技術文書の「書き方」−共通のポイントと各種文書への応用−


ワープロの手が進まない」の解決策
−テクニカルライティングの手法で文を導く−

 

当コーナーの主旨

 「目的に応じた技術文をいかに書くか」を切り口にテクニカルライティング(技術文書を作成するための知識と手法の体系)の基本的な考え方を解説します.さらに ,テクニカルライティングを基盤にして各種の技術文書(報告書,機能仕様書,製品解説,マニュアルなど)をまとめる際のポイントを解説します.


ワープロの手が進まない」の原因解決糸口

わかっているのだが,書けない」と思っていても,なんらかのきっかけ”で文 が浮かぶ場合があります.また,書けなくとも「尋ねられると,説明できる」こともあります.「文にまとまらない」という発散的な状態から「文にまとまる」に収束する“きっかけ”を得る手法があれば執筆が効率化 するはずです.

解決策は,「テクニカルライティング」にあります.けして,大げさな手法を述べるつもりはありません.文は「書こうとする対象」の“とらえ方”から生まれます.対象をどのような「視点」あるいは「見方」でとらえるかを“きっかけ”にすれば,飽和状態の思考に方向性が生まれ主題(書こうとするテーマ)に応じた文をまとめられるはずです.


対話でならば,説明できる」と「わかっているのだが,書けない」の違い

同じ主題であっても,「話す」と「く」では状況が異なります.対話では,相手と自分の関係が明確であり,語るべき主題もいくつかに分割(対話の一区切り)されます.また,必要ならば相手が補足を求めてきます.相手がいて,主題を大局的あるいは部分的な見方で分割して尋ねてくれれば,それに沿って答えて行くだけで 説明が成り立ちます.

ならば,「書く」でも対話と“同じような状況(相手との関係,大局的あるいは部分的な見方)”を仮想的に構築すれば,「書けない」の問題は解決に向かうはずです.

「話す」と「書く」の違い


解決につながるテクニカルライティングポイント

「話す際の主題」と「主題に対する一区切りの説明」は,文書では「見出し」と「段落」に相当します.さらに「大局的あるいは部分的な見方」と「相手との関係」は,テクニカルライティングの手法ではそれぞれ「主文 −補足文」構成と「主たる視点」に対応します. いずれも,読者の理解につながるとともに執筆者が文をまとめる“きっかけ(導入)”になりえます.また,「主文-補足文」構成と「主たる視点」によって文もしくは段落のアウトライン(輪郭)が構成されます.

解決のポイント1:段落を「主文−補足文」構成で表す

主文−補足文」構成とは,段落を「主文(見出しに対する要点)」と「補足文(主文の補足)」で構成する手法です.

解決のポイント2:文書目的に応じた「主たる視点」を使う

主たる視点」とは,技術文書を「仮想空間」としてとらえた際に「中心になって行為する人」です.いわゆる「人称」に相当します. 仮想空間の“主役”とご理解ください.技術文書に限らず日本語の文書では,執筆者と読者の関係が人称に反映されます.文書目的に応じて「主たる視点」を的確に位置付けると,文体が統一されるとともに 執筆者と読者の関係が明確になります.


各種文書への応用

「主文-補足文」構成と「主たる視点」は,特別な手法ではありません.さまざまな技術文書で積み重ねられかつ読者に受け入れられてきた「技術を文書で伝える技術」のエッセンスと言えます.「主文 −補足文」構成と「主たる視点」 は,各種の技術文書を作成する際の基盤(いわば,プラットフォーム)になります.また,技術文書のみならずビジネス文書(例:議事録 ,納入仕様書)などの実務文書にも応用できます.

テクニカルライティング−技術文書を作成する際の基盤−


次ページに進む(ボタンをクリックしてください)

当コーナー主旨とご閲覧にあた ってのお願い

当コーナーは,当社のテクニカルライティング研修コース(出張開催セミナー)の抜粋・プレビュー版です.

  • 当コーナーの内容を各種の文書作成の参考にしていただくことは作者の意とするところであり,これが皆様のお役に立てば誠に幸いです.ただし,内容の一部あるいは全部の転載(他のWebサイトや他の出版物,等に収録・再配布する) および当著作物の二次使用を禁じます.

  • また,上記の主旨より当コーナーはご覧いただいた方々に議論を呈することを目的としておりません.当社セミナーの開催に関するお問合せ以外には,お答えいたしかねる場合がありますのであらかじめご了承ください.

 
テクニカルライティングセミナー
 

テクニカルライティングセミナー(出張開催形式)技術の1stステップ」,(同)+技術メール編」,(同)+ビジネス文書編」では,要点が明確な技術文書を作成するための共通基礎と手法を事例中心で解説します.

.



.

テクニカルドキュメント・ビジネスドキュメントためのテクニカルライティングセミナー
わかりやすい技術文書・ビジネス文書の作成手法
技術文書の「書き方」−共通のポイントと各種文書への応用−
Copyright:Takaaki-YAMANOUCHI/1995-2010
山之内孝明/(有)山之内総合研究所
Takaaki Yamanouchi/ Yamanouchi Research Institute,Ltd.