今日はサポートの文章の書き方について。
ここで私が指すサポート文書というのは
Webに掲載する用だったり
メールの返信用だったり、
客先に提出する報告書用だったり
biz-Streamについて書かれる文書いろいろを指しています。
その書き方なのですが、
自分がそういったものを書くことを担当するときに心がけていることがあります。
正しい日本語で「簡潔」に書くこと
簡潔にというのが特に重要です。
丁寧に敬語で書いたり修飾語で飾り立てても
まわりくどく書いたらわけがわからないのです。
お客様向けの文書なので敬体じゃないと駄目な気がするかもしれないですが
事象を説明している箇所などはむしろ敬体ではなく常体でもよいくらいです。
解法を箇条書きで書いてもいいんです。
わかりやすさが一番です。
何故なら、サポート文書を読む人は
たいていちょっとばかり頭にきているからです。
問題なく使っている人はサポートページを見ようとは思いません。
不具合があったり、上手くいかないことがあったり
思うように使えなかったりと状況は様々ですが
製品を使う上で何かしら問題がある人が
その製品のサポートの文章を読みに来ているのです。
そのイラっとしている人に対してまわりくどい文章を提供するのはダメです。
いくら丁寧な文章でも長々と書いてあったら読む気がなくなってしまいます。
また、変な日本語やわかりにくい表現で書いてもダメです。
とにかくわかりやすく。
たとえば・・・海外や外資系会社製品のサポート情報ページで
英語を自動翻訳したわけのわからない日本語を見かけることはありませんか？
おそらく読んでも問題はすぐに解決しなかったでしょう。
たとえ正しい情報が詳細に書いてあっても読んだ人がわからなかったら意味がないんです。
開発に関わる方はサポート用の文書ではなく
仕様書などを書く機会が多いことと思います。
でももしかしたらサポート文書や報告書を書く機会があるかもしれません。
そのときは使い慣れてない正しい（？）敬語を無理矢理使って
一見外向けの文書を作るのではなく、
わかりやすく簡潔な文章を書くことを心がけてみてください。
文章を書くのが苦手とか敬語が上手く使えない、とかいう方でも
ユーザの役に立つサポート文書は書けると思います。
