技術文書の書き方－共通のポイント－

<BODY BGCOLOR="#ffffff" LINK="#ffffff" VLINK="#ffffff" ALINK="#ebc83d"> <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" width="570" height="150" alt="技術文書の「書き方」－共通のポイントと各種文書への応用－"><HR> <H1 style="line-height: 150%"><span class="style13">「</span><span class="style14">技術者が得意な方法</span><span class="style13">」で取り組む</span><span style="font-weight: 400; letter-spacing: 2pt"><font color="#800000" size="5"><br> </font></span><span style="letter-spacing: 2pt; font-weight: 400;"> <font color="#000080" size="5">－</font></span><span class="style3"><font size="5">「技術者は文書作成が苦手」の“迷信”に終止符を打つ </font></span><span style="letter-spacing: 2pt; font-weight: 400;"> <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; text-indent:15"> 「論理的かつ柔軟に技術課題を解決されている<span class="style2">技術者の皆さんこそ文書作成が得意</span>」と確信しています。適切な取組み方を知れば、技術文書の作成も負担ではなくなります。 </p> </td> </tr> </table> </blockquote> </blockquote> <HR> <H3 class="style15"><span class="style13">テクニカルライティング</span><span class="style16">で課題を解決する</span><strong> </strong> </H3> <p style="LINE-HEIGHT: 150%; MARGIN: 1px 10px; text-indent:15"> 技術課題を解決する場合と同様に、技術文書の作成にも基本となる知識や手法が欠かせません。<span class="style2">テクニカルライティングとは、技術文書を作成するための知識と手法の体系</span>です。</p> <ul> <li> <p style="line-height: 150%; margin-top:0; margin-bottom:15" class="style4"> <font color="#000080"> 技術課題に向き合う際、技術者の皆さんは蓄えてきた「基礎理論」や「目的に応じた実践手段」を活用して解決しようとするはずです。技術文書でこれらに相当するのがまさにテクニカルライティングです。</font></p> </li> <li> <p style="line-height: 150%; margin-top:0; margin-bottom:15" class="style4"> 基本を把握して「誰に何を伝えるべきか」を文に表してゆけば、文書作成が円滑に進みます。同時に、読者にとってもわかりやすい技術文書になります。</p> </li> </ul> <p style="margin: 1px 10px; line-height: 150%; text-indent: 15px;">テクニカルライティングは、「文章の書き方」をはじめ「見出し構成の考え方」、「見やすい図・表の作り方」さらには「用語の使い方」、「書式の選び方」などわかりやすい技術文書の作成に必要な基礎知識と応用手法で構成されています。テクニカルライティングによって、<span class="style2">文書作成の効率化</span>と<span class="style2">文書品質の向上</span>の両立を図るとともに、文書作成による知的生産を「企業力」に結びつけるまでを目標としています。</p> <p align="center" style="line-height: 150%; margin-top: 0px; margin-bottom: 15px"> <img alt="" src="fig-t00/tgb001.jpg" width="480" height="360" class="style5"></p> <p style="line-height: 150%; margin: 1px 10px; text-indent:15"> テクニカルライティングは、エンジニアリングの一つと言えます。企業の技術者の皆さんに共通して身につけていただきたい基礎技術です。断片的な知識に基づいた習慣で技術文書を作成をしているならば、技術者個人としても企業としても大きな損失です。</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><span class="style2"><strong> </strong></span><span class="style18">苦手意識の元凶</span><span class="style17">を知り、テクニカルライティングで苦手を得意に変える</span></H3> <p style="line-height: 150%; margin: 1px 10px; text-indent:15"> もし、文書作成が苦手と考えておられるのならば、これまでに文書を書くための知識と手法を体系的に知る機会はあったか否かを思い起こしてみてください。断片的な知識や経験だけで文書作成に臨んできたのが苦手意識の原因かもしれません。</p> <ul> <li> <p style="line-height: 150%; margin-top:0; margin-bottom:15" class="style4"> 学生時代にレポートや卒論の書き方の指導を受けた経験があると思います。しかし、企業で上司から求められる報告書を的確に書けているでしょうか。機能仕様書やマニュアルに至っては、前例をそのまま「雛型」にしただけの書き方をしていないでしょうか。</p> </li> <li> <p style="line-height: 150%; margin-top:0; margin-bottom:15" class="style4"> 上司として技術文書を校閲する立場ならば、部下に対して適切な書き方の指導ができているでしょうか。「わかりづらい」と指摘するだけで、「なぜわかりづらいのか」を明確にして適切な改善方法を示せているでしょうか。</p> </li> </ul> <p style="line-height: 150%; margin: 1px 10px; text-indent:15"> 「今さら技術文書の基本を学び直すなど大変」と思う必要はありません。これまでの知識を整理し、必要な知識を補完するだけですみます。何がわかりやすさの基本となるかを確認すれば、さまざまな技術文書を的確かつ効率的に作成する手法が身につきます。 </p> <ul> <li> <p style="line-height: 150%; margin-top:0; margin-bottom:15" class="style4"> <font color="#000080" class="style4">テクニカルライティングは、技術者の皆さんが積み上げてきた文書作成の経験を否定するものではありません。むしろ、文書作成を体系的にとらえることで得てきた知識を有効に使えるようになります。</font></p> </li> </ul> <hr> <H3 class="style17">技術文書で<span class="style2">知的財産</span>を生産する</H3> <p style="line-height: 150%; margin: 1px 10px; text-indent:15"> 企業にとって文書作成は知的生産の要です。技術文書は、まぎれもなく企業の成果物であり知的財産です。また、文書作成の効率化は、そのまま業務の効率化につながります。さらに、文書品質の向上は、製品品質の向上や顧客満足度の向上にもつながります。</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"> <span class="style4">文書作成業務の改善に際して、定型化や電子化などをお考えになるかもしれません</span><font color="#000080">。しかし、それらは一つの手法にすぎません。手法を構築するための基礎を知らないまま導入を進めてしまうのは極めて危うい判断です。</font><span class="style4">誤った方向に舵を切ってしまうと、取り返しがつかない事態になりかねません。定型化や電子化に傾倒して本当に「書けない」、「伝わらない」は解決するのかどうか、よく考えてみる必要があります。</span></p> </li> </ul> <p style="line-height: 150%; margin: 1px 10px; text-indent:15"> 開発や生産にかかわらず「企業力」を高めるには、企業全体の知力の向上が欠かせません。文書作成を知的生産ととらえるならば、テクニカルライティングによる「知的底上げ」が正しい筋道と言えます。 </p> <p style="line-height: 150%; margin: 1px 10px; text-indent:15" class="style7"> <img alt="" src="fig-t00/tgb002.jpg" width="480" height="360" class="style12"></p> <p style="line-height: 150%; margin-top:0; margin-bottom:15" align="center"> </p> <hr> <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><HR><DIV ALIGN=CENTER><A HREF="../../default.htm" TARGET="_parent"> <IMG SRC="../gif/modoru.gif" ALT="" ALIGN=BOTTOM width="180" height="50"></A></DIV> <HR> <p><B>＜<FONT COLOR="#800000">当コーナー</FONT>の<FONT COLOR="#800000">主旨</FONT>とご閲覧にあたっての<FONT COLOR="#800000">お願い</FONT>＞</B></p> <TABLE BGCOLOR="#000080" cellspacing="1" style="border-collapse: collapse" bordercolor="#111111" width="90%" cellpadding="6"> <TR> <TD BGCOLOR="#ffffff"> <p style="line-height: 150%; margin-top: 5; margin-bottom: 5; margin-right:10; text-indent:15"> 当コーナーは、当社の<FONT COLOR="#800000">テクニカルライティング研修コース</FONT><FONT COLOR="#000000">（出張開催セミナー）</FONT>の抜粋・プレビュー版です。<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>　<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 WIDTH=400 HEIGHT=98 VSPACE=10></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 TARGET="_blank" href="../t6-1st-pdf/gaiyo-gb1st.pdf"> <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 WIDTH=400 HEIGHT=98 VSPACE=10></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 TARGET="_blank" href="../t6-1st-a-pdf/gaiyo-gb1st-a.pdf"> <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 WIDTH=400 HEIGHT=98 VSPACE=10></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 TARGET="_blank" href="../t6-1st-b-pdf/gaiyo-gb1st-b.pdf"> <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> Copyright: Takaaki-YAMANOUCHI/1995-2017<BR> 山之内孝明／有限会社　山之内総合研究所<BR> Takaaki Yamanouchi/ Yamanouchi Research Institute, Ltd.</p> </BODY>