usaco’s diary

日常のこととか、ジブン手帳のこととか、文房具のこととか。その他気になってることとかを残していく予定です。

ライティングについて

 

technicalwriting01

こんにちわ。うさこ(@cocoaxik)です。
今日は、あたしが長年携わってきている、「テクニカルライティング」について少しお話してみようかな…と思います⸜(* ॑ ॑* )⸝

 

 

テクニカルライティングとは

簡単に言うと、「技術文書を書く」事なのですが、単に書けばいいというものではありません。

専門的な機能のすべてを網羅して書かなければなりません。

ですので、会社で目的を持って「外部(第三者)」に配布するドキュメントはすべてテクニカルライティング、会社が責任を持って文書なのです。

少なくとも、あたしはそう解釈をしてドキュメントを作ってきました。

  • 当然ですが、テクニカルライティングは、小説のように叙情的であってはなりません。
  • 作成した文書は品質保証のために、校閲、精査されてからでないと社外には公開できません。
  • 会社はこれらを行わずに公開されるときのリスクを負わなければならないためです。

 

電化製品などの普及によって、日本でもテクニカルライティングがとても重要となりました。

また、英文の翻訳なども立派なテクニカルライティングです。


テクニカルライティングにおけるルール

テクニカルライティングを行う上で、ルールというか気をつけなければならない大事なポイントがあります。

相手にそのままを伝える、という意味ではいつも書く文章と変わらないコトなのですが、特に注意か必要になるとあたしは思っています。

 

テクニカルライティングで大事なコト

  1. 作成する文書自体の目的が何であるかを明確に示すこと
  2. 読み手(操作する人)を明確にした文書作成をすること

 

どちらも文章を書く上ではとても大事な事なのですが、この2つは特に大事なポイントです。

例えば、アプリケーションや電化製品などのマニュアルならば、初めてアプリケーションや電化製品を購入した人が、マニュアルを順番に読むことで操作できるように、最初から最後までを理解しやすい構成で作成しなければなりません。

そして、読み手が専門知識のある人向けなのか、あるいは一般的な人なのか。それを考えて書くことも大事なことです。

文章の理解度は、どうしてもその人の持っている知識によって違ってきます。
なので、どんなときも文章は簡単、かつ簡潔であることがとても大事です。

特に、主語と述語の関係は明瞭に記載しなければなりません。

自分で分かってしまっていると主語や目的語を省いてしまいがちですが、これを省いてしまうと、読み手に想像をしながら作業してもらわなければならなくなります。

 

最後に

テクニカルライティングって、簡単なようで難しいんですよね。

気をつけて書いていても、読み直すと抜けてる…なんてこともあります。

長年やって来ていますが、なかなか1回で完成っとは行きません。

今回は基礎の基礎を書いてみました。

PV見てみて気が向いたらまた続きをアップしてみます( 'ω'o[ ]o

 

 

 

 

 

クラウドソーシング「ランサーズ」