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

<BODY BGCOLOR="#ffffff" LINK="#ffffff" VLINK="#ffffff"> <P> <img border="0" src="fig-t00/gb-bar-introduction.gif" width="540" height="26" alt="わかりやすい技術文書へのアプローチ"><BR> <img border="0" src="fig-t00/tgb00-ttl.gif" alt="技術文書の「書き方」－共通のポイントと各種文書への応用－" width="570" height="150"><HR> <H1 style="line-height: 150%"><span style="font-weight: 400; letter-spacing: 2pt"> 「<font color="#800000">ワープロの手が進まない</font>」の解決策<font color="#800000" size="5"><br> </font><font color="#000080" size="5">－テクニカルライティングの手法で文を導く－</font></span></H1> <blockquote> <blockquote> <table border="0" cellspacing="0" width="75%" style="border-collapse: collapse" bordercolor="#111111" cellpadding="0"> <tr> <td width="10" bordercolor="#000000" bgcolor="#008080" bordercolorlight="#FFFFFF" bordercolordark="#FFFFFF">　</td> <td bordercolor="#000000" bgcolor="#FFFFFF" bordercolorlight="#FFFFFF" bordercolordark="#FFFFFF"> <p style="line-height: 150%; margin-left:10; margin-right:10; margin-top:2; margin-bottom:0"> <b><font color="#800000">当コーナーの主旨</font></b></p> <p style="line-height: 150%; margin-left:10; margin-right:10; margin-top:2; margin-bottom:0">  「目的に応じた技術文をいかに書くか」を切り口にテクニカルライティング（技術文書を作成するための知識と手法の体系）の基本的な考え方を解説します。さらに、テクニカルライティングを基盤にして各種の技術文書（報告書、機能仕様書、製品解説、マニュアルなど）をまとめる際のポイントを解説します。</p> </td> </tr> </table> </blockquote> </blockquote> <HR> <H3>「<font color="#800000">ワープロの手が進まない</font>」の<font color="#800000">原因</font>と<font color="#800000">解決</font>の<font color="#800000">糸口</font></H3> <p style="LINE-HEIGHT: 150%; MARGIN: 1px 10px"> 「<font color="#003300">わかっているのだが、書けない</font>」と思っていても、<font color="#800000">なんらかの</font>“<font color="#800000">きっかけ</font>”で文が浮かぶ場合があります。また、書けなくとも「尋ねられると、説明できる」こともあります。「文にまとまらない」という発散的な状態から<font color="#800000">「文にまとまる」に収束する“きっかけ”を得る手法</font>があれば執筆が効率化するはずです。</p> <ul> <li> <p style="line-height: 150%; margin-top:0; margin-bottom:15"> <font color="#000080"> 「報告内容については自分が最もよく知っているのだが、報告書の最初の1文がうまく書けない」あるいは「製品解説の第1文が書けても、その先が続かない」というのは、もどかしくストレスをはらんだ状態です。書き始める際は頭の中の情報量がピークとも言える思考の飽和状態です。“うまく”まとめようとする、それがさらに執筆者の負担になります。</font></p> </li> <li> <p style="line-height: 150%; margin-top:0; margin-bottom:15"> <font color="#000080"> まとまらないからと言って、「以下に・・・について解説します」としただけでは何の解決にもなりませんし、図を示しただけでは読者に「要点は何」と指摘されてしまいます。下書きしたり、ロジカルシンキング（問題解決手法）で思考を分析し始めては、大げさになり時間を要します。</font></p> </li> </ul> <p style="margin:1px 10px; line-height: 150%; "> 解決策は、「<font color="#800000">テクニカルライティング</font>」にあります。けして、大げさな手法を述べるつもりはありません。文は「書こうとする対象」の“<font color="#800000">とらえ方</font>”から生まれます。対象をどのような「<font color="#800000">視点</font>」あるいは「<font color="#800000">見方</font>」でとらえるかを“きっかけ”にすれば、飽和状態の思考に方向性が生まれ主題（書こうとするテーマ）に応じた文をまとめられるはずです。</p> <ul> <li> <p style="line-height: 150%; margin-top:0; margin-bottom:15"> <font color="#000080">文の冒頭で「本製品は」と書いた後に手が止まってしまうのならば、製品を十分に知っていても、文書の目的に応じたとらえ方が十分でないのかもしれません。方向性をもたずワープロに向かい、「・・・は」と見切り発車で入力しても、文は生まれません。無理にその後を続けても「長文」あるいは「主語と述語の対応が不自然な文」に陥りやすくなります。執筆者は、またそこで考え込んでしまうことになります。</font></p> </li> </ul> <hr> <H3>「<font color="#800000">対話でならば、説明できる</font>」と「<font color="#800000">わかっているのだが、書けない</font>」の違い</H3> <p style="line-height: 150%; margin: 1px 10px">同じ主題であっても、「<font color="#800000">話す</font>」と「<font color="#800000">書</font>く」では状況が異なります。対話では、相手と自分の関係が明確であり、語るべき主題もいくつかに分割（<font color="#800000">対話の一区切り</font>）されます。また、必要ならば相手が補足を求めてきます。相手がいて、<font color="#800000">主題を大局的あるいは部分的な見方で分割</font>して尋ねてくれれば、それに沿って答えて行くだけで説明が成り立ちます。</p> <ul> <li> <p style="line-height: 150%; margin-top:0; margin-bottom:15"> <font color="#000080"> たとえば、上司に対話である課題が解決したことを報告するとします。「（私が担当した）問題は解決しました」、「いくつかの原因が複合していますが、直接原因は＊＊＊です」と要点から報告します。もし要点を述べないと、上司が「細かい話は後でいいから、結論を先に言ってくれ」と要点を促します。この際、「（私は）設計変更が必要と考えます」と言葉に表れませんが、報告者の視点で見解を述べます。人称としてとらえれば「私（I）」です。</font></p> </li> <li> <p style="line-height: 150%; margin-top:0; margin-bottom:15"> <font color="#000080"> あるいは、展示会で来場者に製品を説明するとします。来場者の傍らでともに製品を前にして、来場者が知っている用語を主体にして語り、知らないであろう用語を使った場合はすぐに補足するでしょう。説明者は来客に「お客様」と呼びかけますが、人称としてとらえれば「あなた（You）」です。「（あなたの）問題を解決します。（あなたは）是非お試しください」と来場者の視点で語るはずです。</font></p> </li> </ul> <p style="line-height: 150%; margin: 1px 10px"> ならば、「書く」でも対話と“<font color="#800000">同じような状況</font>（相手との関係、大局的あるいは部分的な見方）”を<font color="#800000">仮想的に構築</font>すれば、「書けない」の問題は解決に向かうはずです。</p> <ul> <li> <p style="line-height: 150%; margin-top:0; margin-bottom:15"> <font color="#000080"> ここで言う“同じような状況で書く”とは、対話での「主題に対する一区切りの大局的あるいは部分的な見方」と「相手との関係」を文に反映することです。けして「対話形式で文をまとめる」あるいは「会話調の文体で書く」ことではありません。</font></p> </li> </ul> <p style="line-height: 150%; margin-top:0; margin-bottom:15" align="center"> <img border="1" src="fig-t00/tgb00ab1.jpg" vspace="10" alt="「話す」と「書く」の違い" width="480" height="360"></p> <hr> <H3><font color="#800000">解決</font>につながる<font color="#800000">テクニカルライティング</font>の<font color="#800000">ポイント</font></H3> <p style="margin:1px 10px; line-height: 150%"> 「話す際の主題」と「主題に対する一区切りの説明」は、文書では「<font color="#800000">見出し</font>」と「<font color="#800000">段落</font>」に相当します。さらに「大局的あるいは部分的な見方」と「相手との関係」は、テクニカルライティングの手法ではそれぞれ「<font color="#800000">主文－補足文</font>」構成と「<font color="#800000">主たる視点</font>」に対応します。いずれも、読者の理解につながるとともに執筆者が文をまとめる“<font color="#800000">きっかけ</font>（導入）”になりえます。また、「主文-補足文」構成と「主たる視点」によって文もしくは<font color="#800000">段落のアウトライン</font>（輪郭）が構成されます。</p> <h4><font color="#008080">解決のポイント1：段落を「主文－補足文」構成で表す</font></h4> <p style="line-height: 150%; margin: 1px 10px"> 「<font color="#800000">主文－補足文</font>」構成とは、段落を「主文（<font color="#800000">見出しに対する要点</font>）」と「補足文（<font color="#800000">主文の補足</font>）」で構成する手法です。</p> <ul> <li> <p style="line-height: 150%; margin-top: 0; margin-bottom: 15"> <font color="#000080">「全体と部分（構成要素）」あるいは「主体と補足」による構成は、執筆者が書こうとしている主題（見出し名）に対し「全体としては」と「その部分は」という文にまとめる“きっかけ”を提示します。</font></p> </li> <li> <p style="line-height: 150%; margin-top: 0; margin-bottom: 15"> <font color="#000080">また、読者にとっては「明確な要点とそれに必要な付帯情報」になり、「主文－補足文」構成は執筆者と読者の双方に有効です。</font></p> </li> </ul> <h4><font color="#008080">解決のポイント2：文書目的に応じた「主たる視点」を使う</font></h4> <p style="margin:1px 10px; line-height: 150%"> 「<font color="#800000">主たる視点</font>」とは、技術文書を「<font color="#800000">仮想空間</font>」としてとらえた際に「<font color="#800000">中心になって行為する人</font>」です。いわゆる「人称」に相当します。仮想空間の“主役”とご理解ください。技術文書に限らず日本語の文書では、執筆者と読者の関係が人称に反映されます。文書目的に応じて「主たる視点」を的確に位置付けると、文体が統一されるとともに執筆者と読者の関係が明確になります。</p> <ul> <li> <p style="line-height: 150%; margin-top:0; margin-bottom:15"> <font color="#000080"> たとえば、製品を対話で説明する際には「傍らにいるあなた」に向けて語ります。同様に、製品解説・マニュアルでは文には表れませんが「（ユーザである）あなた」が「主たる視点」になります。</font></p> </li> <li> <p style="line-height: 150%; margin-top:0; margin-bottom:15"> <font color="#000080"> 「主たる視点」は、単に「省略された主語」ではなく、「（あなた）により／（あなた）にとって／（あなた）には／（あなた）から見ると」など活用形となり、文には表れなくとも文をまとめる“きっかけ”になります。</font></p> </li> </ul> <hr> <H3><font color="#800000">各種文書</font>への<font color="#800000">応用</font></H3> <p style="line-height: 150%; margin: 1px 10px"> 「主文-補足文」構成と「主たる視点」は、特別な手法ではありません。さまざまな技術文書で積み重ねられかつ読者に受け入れられてきた<font color="#800000">「技術を文書で伝える技術」のエッセンス</font>と言えます。「主文－補足文」構成と「主たる視点」は、<font color="#800000">各種の技術文書を作成する際の基盤</font>（いわば、プラットフォーム）になります。また、技術文書のみならずビジネス文書（例：議事録、納入仕様書）などの実務文書にも応用できます。</p> <ul> <li> <p style="line-height: 150%; margin-top:0; margin-bottom:15"> <font color="#000080">  技術者の皆さんが技術に関するさまざまな課題に向き合う際には、なんらかの「基礎理論」、「目的に応じた実践手段」さらには「問題が発生した際の解決策」をもって臨むはずです。技術文書でこれらに相当するのがまさにテクニカルライティング（技術文書を作成するための知識と手法の体系）です。</font></p> </li> <li> <p style="line-height: 150%; margin-top:0; margin-bottom:15"> <font color="#000080"> テクニカルライティングは、技術者の皆さんが得てこられてきた文書作成の技術を否定するものではありません。むしろ、文書作成を体系的にとらえ補完することにより、得てきた知識を有効に使う手法と言えます。</font></p> </li> </ul> <p style="margin:1px 10px; line-height: 150%" align="center"> <img border="1" src="fig-t00/tgb00ab2.jpg" vspace="10" alt="テクニカルライティング－技術文書を作成する際の基盤－" width="480" height="360"></p> <hr> <DIV style="line-height:1.5"> <p></DIV> <p> <a target="_parent" href="tgb-00-01f.htm"> <IMG SRC="../t1/nxt.gif" ALT="" ALIGN=BOTTOM width="37" height="37"></a> <B>次ページに進む</B><FONT COLOR="#008080"><B>（ボタンをクリックしてください）</B></FONT></p> <HR><DIV ALIGN=CENTER><A HREF="../../index.htm" TARGET="_parent"> <IMG SRC="../gif/modoru.gif" ALT="" ALIGN=BOTTOM width="180" height="50"></A></DIV> <HR> <p>　</p> <DIV STYLE="padding-top:3px;padding-right:3px;padding-bottom:3px;padding-left:3px;"><B>＜</B><FONT COLOR="#800000"><B>当コーナーのご利用にあたり</B></FONT><B>＞</B></DIV> <TABLE BORDER BGCOLOR="#808080"> <TR> <TD BGCOLOR="#ffffff"> <ul> <li> <p style="line-height: 150%; margin-top: 5; margin-bottom: 5">当コーナーの内容を各種の文書作成の参考にしていただくことは作者の意とするところであり、これが皆様のお役に立てば誠に幸いです。ただし、内容の一部あるいは全部の転載（他のWebサイトや他の出版物、等に収録・再配布する）および当著作物の二次使用を禁じます。</li> <LI TYPE=disc> <p style="line-height: 150%; margin-top: 5; margin-bottom: 5"> また、上記の主旨より本コーナーはご覧いただいた方々に議論を呈することを目的としておりません。当社セミナーの開催に関するお問合せ以外には、お答えいたしかねる場合がありますのであらかじめご了承ください。</ul> </TD> </TR> </TABLE> <p>　</p> <HR> <DL> <DT> <IMG SRC="../gif/sec-teian-a.gif" ALT="テクニカルライティングセミナー" ALIGN=BOTTOM width="540" height="26"><TABLE cellspacing="0" cellpadding="0" width="913"> <TR> <TD VALIGN=TOP WIDTH=73> 　</TD> <TD VALIGN=TOP BGCOLOR="#0080c0" WIDTH=5><BR> </TD> <TD VALIGN=TOP WIDTH=835> <p style="line-height: 150%; margin: 4 3"><FONT COLOR="#000080"><B>テクニカルライティングセミナー</B></FONT>（出張開催形式）<SPAN STYLE="padding-top:5px;padding-right:5px;padding-bottom:5px;padding-left:5px;">「</SPAN><FONT COLOR="#800000"><B>技術の1stステップ</B></FONT>」、<SPAN STYLE="padding-top:5px;padding-right:5px;padding-bottom:5px;padding-left:5px;">「</SPAN>（同）<FONT COLOR="#800000"><B>＋技術メール編</B></FONT>」、<SPAN STYLE="padding-top:5px;padding-right:5px;padding-bottom:5px;padding-left:5px;">「</SPAN>（同）<FONT COLOR="#800000"><B>＋ビジネス文書編</B></FONT>」では、要点が明確な技術文書を作成するための共通基礎と手法を事例中心で解説します。</TD> </TR><TR> <TD VALIGN=TOP WIDTH=73> <DIV STYLE="font-size:1px"></DIV> </TD> <TD VALIGN=TOP BGCOLOR="#0080c0" WIDTH=5> <DIV STYLE="font-size:2pt"></DIV> </TD> <TD VALIGN=TOP BGCOLOR="#0080c0" WIDTH=727> <DIV STYLE="font-size:2pt">.</DIV> </TD> </TR><TR> <TD VALIGN=TOP WIDTH=73> <DIV ALIGN=CENTER></DIV> </TD> <TD VALIGN=TOP BGCOLOR="#0080c0" WIDTH=5><BR> </TD> <TD VALIGN=TOP WIDTH=727> <DIV ALIGN=LEFT> <TABLE> <TR> <TD> <IMG SRC="../gif/tw6-sub6mnl-ss-1st.gif" ALT="技術文書の1stステップ" ALIGN=TOP VSPACE=10 width="400" height="98"></TD> <TD> <A HREF="../t6-1st/gb-smnr-1st.htm" TARGET="_parent"> <IMG SRC="../gif/lnk-htmlsg.gif" ALT="" ALIGN=BOTTOM width="95" height="36"></A></TD> <TD> <A HREF="../t6-1st-pdf/gaiyo-gb1st.pdf" TARGET="_parent"> <IMG SRC="../gif/lnk-pdf2sg.gif" ALT="" ALIGN=BOTTOM width="210" height="36"></A></TD> </TR> </TABLE> </DIV> </TD> </TR><TR> <TD VALIGN=TOP WIDTH=73> <DIV ALIGN=CENTER></DIV> </TD> <TD VALIGN=TOP BGCOLOR="#0080c0" WIDTH=5><BR> </TD> <TD VALIGN=TOP WIDTH=727> <DIV ALIGN=LEFT> <TABLE> <TR> <TD> <IMG SRC="../gif/tw6-sub6mnl-ss-1st-a.gif" ALT="技術文書の1stステップ＋技術メール編" ALIGN=TOP VSPACE=10 width="400" height="98"></TD> <TD> <A HREF="../t6-1st-a/gb-smnr-1st.htm" TARGET="_parent"> <IMG SRC="../gif/lnk-htmlsg.gif" ALT="" ALIGN=BOTTOM width="95" height="36"></A></TD> <TD> <A HREF="../t6-1st-a-pdf/gaiyo-gb1st-a.pdf" TARGET="_parent"> <IMG SRC="../gif/lnk-pdf2sg.gif" ALT="" ALIGN=BOTTOM width="210" height="36"></A></TD> </TR> </TABLE> </DIV> </TD> </TR><TR> <TD VALIGN=TOP WIDTH=73> <DIV ALIGN=CENTER></DIV> </TD> <TD VALIGN=TOP BGCOLOR="#0080c0" WIDTH=5><BR> </TD> <TD VALIGN=TOP WIDTH=727> <DIV ALIGN=LEFT> <TABLE> <TR> <TD> <IMG SRC="../gif/tw6-sub6mnl-ss-1st-b.gif" ALT="技術文書の1stステップ＋ビジネス文書編" ALIGN=TOP VSPACE=10 width="400" height="98"></TD> <TD> <A HREF="../t6-1st-b/gb-smnr-1st.htm" TARGET="_parent"> <IMG SRC="../gif/lnk-htmlsg.gif" ALT="" ALIGN=BOTTOM width="95" height="36"></A></TD> <TD> <A HREF="../t6-1st-b-pdf/gaiyo-gb1st-b.pdf" TARGET="_parent"> <IMG SRC="../gif/lnk-pdf2sg.gif" ALT="" ALIGN=BOTTOM width="210" height="36"></A></TD> </TR> </TABLE> </DIV> </TD> </TR> <tr> <TD VALIGN=TOP WIDTH=73 height="3"> <DIV STYLE="font-size:2pt"></DIV> </TD> <TD VALIGN=TOP BGCOLOR="#0080c0" WIDTH=5 height="3"> <DIV STYLE="font-size:2pt"></DIV> </TD> <TD VALIGN=TOP BGCOLOR="#0080c0" WIDTH=727 height="3"> <DIV STYLE="font-size:2pt">.</DIV> </TD> </tr> </TABLE> <DT> <hr> </DL> <p> <B>テクニカルドキュメント・ビジネスドキュメントためのテクニカルライティングセミナー</B><BR> <B>わかりやすい技術文書・ビジネス文書の作成手法</B><BR> <B>技術文書の「書き方」－共通のポイントと各種文書への応用－<br> </B>Copyright:Takaaki-YAMANOUCHI/1995-2010<BR> 山之内孝明／(有)山之内総合研究所<BR> Takaaki Yamanouchi/ Yamanouchi Research Institute,Ltd.</p> </BODY>