「テクニカルライティング」とマニュアル作成 -ステップ2［構成］

<BODY BGCOLOR="#ffffff"> <P><IMG SRC="t1-ttl.gif" ALT="" ALIGN=BOTTOM WIDTH=570 HEIGHT=180><HR><BR></P><H2>2. テクニカルライティングで考えたマニュアル作成<BR></H2><P><HR><BR></P><H1> 2-3　ステップ2［構成（執筆）］<BR> <FONT SIZE=5 COLOR="#000080">－技術情報を分解・再構築する－</FONT><BR></H1><P><HR><BR></P><UL> 前節では目次作りが重要であることをお話しました．ここでは実際に目次にそって執筆を進めていくためのポイントを解説します．冒頭でも述べましたが，技術情報をいくら詳しく文章にしても読者（ユーザ）には理解してもらえません．技術情報をいったん分解して読者に向けて再構築する作業が目次作りであり執筆です．<BR> </UL><H2><FONT COLOR="#800000">執筆のポイント</FONT><BR></H2><UL> マニュアル原稿を執筆する際のポイントを以下の三つに要約します．<BR> </UL><H3><FONT SIZE=3 COLOR="#000080">ポイント1：　</FONT><FONT COLOR="#000080">執筆の基本ルールをあらかじめ決めておく-「マニュアル執筆要領」を作っておく-</FONT><BR></H3><UL> 用字用語（使用する漢字，送り仮名などの用語表現），文体，見出しの付け方など，執筆の基本ルールをあらかじめ決めておくことをお勧めします．用語や見出しの付け方が不統一であったりすると，それだけで読者はそのマニュアルに不信感をいだくことなり，読者の理解を阻害します．<BR> <UL> <FONT COLOR="#000080">「マニュアル執筆要領」については関連リンクを参照してください．</FONT><BR> </UL><BR> <UL> <LI TYPE=disc>読んでもらうためには読者の信頼を獲得しなければなりません．そのためには正確な日本語表現が基本となります．辞書や用事用語辞典（筆者は東京堂出版の東京堂用字用語辞典を推薦します）をこまめに参照するか，最低限の統一用語を一覧にしておくことをお勧めします．<BR> <LI TYPE=disc>また，専門用語や製品固有用語はできるだけ一般用語に近いものを使用し（社内呼称のような特化された用語は避けるべき），初出の際は同じページ内に注を付ける配慮をしてください．<BR> </UL></UL><H3><FONT SIZE=3 COLOR="#000080">ポイント2：　</FONT><FONT COLOR="#000080">1段落を解説の基本単位にする-1段落1テーマを原則に-</FONT><BR></H3><UL> 最初から「わかりやすく正しい文章を書こう」と意気込んでもなかなか書きにくいものです．むしろあれもこれもといろいろなことが気になりかえって複雑な文章になりがちです．ここではまず，<FONT COLOR="#008080"><B>「小見出し」+「1段落」を解説の基本単位とし，この基本単位で一つのテーマを簡潔に表現する</B></FONT>ことを提案します．<BR> <UL> <FONT COLOR="#000080">さらに詳細な執筆のポイントについては関連リンクを参照してください．</FONT><BR> </UL><BR> <UL> <LI TYPE=disc>わかりやすい文書をいかに書くかということについては永遠の課題かもしれませんが，筆者は<B>「一文の中に，読者が初めて出会うであろう用語や考え方は必ず一つとし，次の文でこれを補足すること」</B>，<B>「原稿用紙に書くというより，目の前の人に語りかけるように表現する」</B>ということを信条としています．<BR> </UL></UL><H3><FONT SIZE=3 COLOR="#000080">ポイント3：　</FONT><FONT COLOR="#000080">文章で書くばかりが執筆ではない-文章を構造化，図化する-</FONT><BR></H3><UL> 製品の取り扱いを解説するマニュアルの内容は，さまざまなケースに対してさまざまな対処方法を示さなければならないことが多々あります．そのような場合にすべてを文章で表現しようとするとかなり煩雑になったり，逆に内容がもれたりすることがあります．文章を構造化，図化することで読者にまず視覚的に内容構成を把握してもらいその上で詳細な内容を読んで理解してもらう手法が有効です．<BR> <BR> <UL> <LI TYPE=disc>文章の構造化，図化といっても特別なことではありません．たとえば，羅列している文章を箇条書きにしたり表化したりするのはその第1歩です．これを進めていくとビジュアルなチャート表現も可能になります．<BR> </UL></UL><P><IMG SRC="../gif/knrn-lnk.gif" ALT="" WIDTH=140 HEIGHT=35><BR></P><UL> <A HREF="../techwrt-2-4p/t-2-4f.htm" TARGET="_parent"><B>第4部　原稿執筆のルール</B></A><FONT COLOR="#800000"><B>-技術文書を書くための基本-</B></FONT><BR> <A HREF="../techwrt-2-5p/t-2-5f.htm" TARGET="_parent"><B>第5部　原稿執筆のポイント</B></A><FONT COLOR="#800000"><B>-正確でわかりやすい文章を書くために-</B></FONT><BR> <A HREF="../techwrt-2-6p/t-2-6f.htm" TARGET="_parent"><B>第6部　ビジュアル化する</B></A><FONT COLOR="#800000"><B>-読む理解+見る理解の重要性-</B></FONT><BR> </UL><P><HR><BR></P><H2><FONT COLOR="#800000">文章の構造化手法の例－マトリクス法</FONT><BR></H2><UL> 文章主体の技術情報を分解し，ビジュアルに再構築するために<B>「マトリクス法」</B>という方法を考案しました．<BR> <BR> 一言で言えば<B>「文書をマトリクス化（表化）し，目的に応じ行・列に入れ替え，補足をし，内容のある項目を系統化する」</B>方法です（<B>図4ご参照</B>）．<BR> </UL><P> <DIV ALIGN=CENTER><IMG SRC="t101fg4.gif" ALT="Fig.T101-4" ALIGN=BOTTOM><BR> 図4 マトリクス法：<B>「情報の分解」</B>と<B>「情報の再構築」</B>に大別されます<BR></DIV></P><H3><FONT COLOR="#000080">スタート</FONT><BR></H3><UL> <UL> <LI TYPE=circle>文書主体の技術資料がベース（たとえば，ワープロデータあるいはテキストファイル）となります．<BR> </UL></UL><H3><FONT SIZE=3 COLOR="#000080">第1段階：　</FONT><FONT COLOR="#000080">箇条書き化</FONT><BR></H3><UL> <UL> <LI TYPE=circle>文書を一つ段落毎に区切りで改行し，箇条書き化していきます．段落は一つの内容のみで構成されることを原則とし，複数の場合はさらに分割します．<BR> </UL></UL><H3><FONT SIZE=3 COLOR="#000080">第2段階：　</FONT><FONT COLOR="#000080">マトリクス化</FONT><BR></H3><UL> <UL> <LI TYPE=circle>箇条書きした文書をマトリクス（たとえば表計算ソフト）に置き換えます．ここで当然埋められない項目がでてきます（さらに具体的な方法は「4.参考事例」で説明します）．<BR> </UL></UL><H3><FONT SIZE=3 COLOR="#000080">第3段階：　</FONT><FONT COLOR="#000080">行同士，列同士の入れ替え，項目の補足</FONT><BR></H3><UL> <UL> <LI TYPE=circle>同じ項目をまとめるように行あるいは列を入れ替えます．さらに説明が必要な事項がある場合は補足します．<BR> <LI TYPE=circle>ここで重要なのは先のステップで述べたように受け手（読者）がどのような理解の過程をするのかを考慮し，項目の順序・調整をすることです．<BR> </UL></UL><H3><FONT SIZE=3 COLOR="#000080">第4段階：　</FONT><FONT COLOR="#000080">項目の統合・関連付け</FONT><BR></H3><UL> <UL> <LI TYPE=circle>第3段階を進めていくと表の左側に同じあるいは関連した項目がまとめられていきます．同じ項目は一つにまとめ関連した項目も主となる項目の近くにまとめます．<BR> </UL></UL><H3><FONT SIZE=3 COLOR="#000080">最終段階：　</FONT><FONT COLOR="#000080">論理のビジュアル化</FONT><BR></H3><UL> <UL> <LI TYPE=circle>最後にマトリクス（表）という表現を離れ，各項目をチャート化します．スタート時点に比べ情報が要点化かつ系統化されるようになります．<BR> </UL><HR><BR> </UL><DL> <DT><FONT COLOR="#008080"><B>[寄り道]</B></FONT><BR> <DD>読者の中で，エンジニアの方がおられたらここで「線形代数」を思い出されるかもしれません．実はこの方法，は筆者が以前に学んだ線形代数をヒントにしたものです．とりわけ行，列を入れ替え，統合・関連付けしていくところはマトリクスを縮退していく過程そのものではないかと思っています．<BR> </DL><P><HR><BR></P><UL> <UL> <LI TYPE=disc>これで基本的には受け手指向の情報の構成ができたわけです．ではさらにこれを見やすくする方法を次のステップで説明します．<BR> </UL></UL><P> <A HREF="t101c2s3.htm" TARGET="_parent"><IMG SRC="nxt.gif" ALT="" ALIGN=BOTTOM></A> <B>次ページに進む（ボタンをクリックしてください）</B><BR> <HR><BR> Copyright:Takaaki-YAMANOUCHI/1995-2001<BR> 山之内孝明／(有)山之内総合研究所<BR> Takaaki Yamanouchi/ Yamanouchi Research Institute,Ltd.<BR> <BR></P></BODY>