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

こんにちは、株式会社PHONE APPLI　UXデベロップメントのハタケヤマです。

いままでサーバーサイドエンジニアとして活動してきましたが、2022年7月にテクニカルライターへと転身しました。

ソースコードを書く人からユーザガイドを書く人へ──「そもそもテクニカルライターとは？」「テクニカルライティングって何？」というところから始まり、少しずつライティングの技法を身につけてユーザガイドへと反映している最中の私です。

今回は、いままでの学習で触れてきた書籍やサイトを紹介いたします。

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

書籍やサイトの紹介へ移る前に、テクニカルライティングとは何か言葉の定義をしておきましょう。

コトバンクで調べると、『デジタル大辞泉』に収録されている次の説明が出てきます。

テクニカル‐ライティング（technical writing）

パソコンや家電製品のマニュアル、機械の仕様書などの、技術的な内容に関する文書を一般向けに作成すること。また、その技法。

（デジタル大辞泉、https://kotobank.jp/word/テクニカルライティング-575566、(参照　2022-08-22)）

なるほど……？

「技術的」と「一般向け」という相容れない言葉が並んでいて、それらを「技法」でなんとかするのが“テクニカルライティング”のようです。

もう少し理解を深めようとWebcat Plus（国立情報学研究所）で「テクニカルライティング」という語を使って連想検索を試みましたが、連想ワードには「英語教育」「撮影」といった語が並んでしまい、めぼしいものは見つからず（http://webcatplus.nii.ac.jp）。

英語科目の授業名で出てくるような意味のwriting、写真撮影時の照明という意味で使うlighting、などがヒットしてしまったようです。

続いてGoogle Trendsで検索したところ、「テクニカル・ライティング」という語が研究分野というジャンルでサジェストされ、関連キーワードとして「日本語スタイルガイド」「テクニカルコミュニケーション」などが挙げられました（https://trends.google.co.jp/trends/explore?date=all&geo=JP&q=%2Fm%2F04jdv6）。

これからテクニカルライティングへの理解を深めていきたい時に使えそうなキーワードを得られたところで、普段私が使っている書籍やサイトの紹介へと移りましょう！

技法を身につけるための書籍・サイト

さて突然ですが、昔々在籍していた職場で、自称IT企業の中の何でも屋さんをやっていた私（開発、検証、営業、ヘルプデスク、キッティングなど）。

何でも屋さんなので、“何でも”持っている訳で。

積ん読状態の本の山を漁ったら必要としている本が出てきました、『日本語表記ルールブック　第2版』です。

持っててよかったー！

何をやるにつけても、文章を書く人はたどり着く書籍だとも言えましょう。

www.editor.co.jp

日本エディタースクール『日本語表記ルールブック　第2版』（2012）、日本エディタースクール出版部

この本のよいところ

「漢字の用い方」や「現代仮名遣いの注意点」、「送り仮名の付け方」をよく参考にします。

SaaSのユーザガイドを作るのであれば縦書きする局面はまずないため、縦書き・横書きの差異に関する説明はあまり読み込んでいません。

それから、元々UXデベロップメントにいた方やユーザガイドの作成に携わっていた方が取得していた資格から、『日本語スタイルガイド　第3版』という書籍を知りました。

先立ってGoogle Trendsで検索した時に、関連キーワードで出てきたものですね。

www.jtca.org

一般財団法人テクニカルコミュニケーター協会『日本語スタイルガイド　第3版』（2016）、テクニカルコミュニケーター協会出版事業部

この本のよいところ

「第2編　日本語スタイルガイド」の「第2章　読みやすく書く」（「ですます」調と「である」調の効果的な使い分けや、助詞の区別の仕方など）をよく参考にします。

知ってはいるけれども、文章を書く時には失念しがちなことが書かれているので、繰り返し目を通すようにしています。

過去にメールや書類のやりとりで痛い目にあったことのある人であれば、経験則として身についている内容も多いのではないでしょうか。

最後に、一番最近購入した書籍『記者ハンドブック第14版』。

www.kyodo.co.jp

一般社団法人共同通信社『記者ハンドブック　第14版』（2022）、共同通信社

この本のよいところ

前述の2冊と比べて、出版されたのがもっとも新しい！

物事を正確にわかりやすく伝える記者の長年のノウハウが濃縮して記載されています。

ルールブックやスタイルガイドと比べると、文章を書く時の規則をより厳格に記載している印象を受けました（送り仮名の本則・許容の差など）。

辞書的な使い方をするので、テクニカルライティングの初学者が使うのであれば、スタイルガイドを先に読んでおいた方が規則の背景などを理解しやすいと思います。

その他に、書籍以外にも以下のサイトを参考にする機会も多いです。

書き方に迷う文章があった場合、ひとまず前述の書籍をパラパラとめくって参考になるものがないか探し、見つからなければインターネットでざっくり検索。検索にヒットした内容を見ながら書籍に再度あたって方針がずれていないか確認する、といった流れを踏むことが多いです。

一般社団法人日本翻訳連盟「スタイルガイド」（https://www.jtf.jp/tips/styleguide）
- ユーザガイドを多言語で書くことはないのですが、望ましい日本語の姿を確認する際に、参考にします。
  使用例や理由が具体的に掲載されているので、自分の書いている文章が例に当てはまるかを見て、妥当性を確認できます。
公用文作成の要領　＞　公用文作成の考え方（https://www.bunka.go.jp/seisaku/bunkashingikai/kokugo/hokoku/93650001_01.html）
- すべてを読み込むというより、文章の方向性がなかなか定まらない時にひとまずどこかに着地させる目的で使っている気がします。
  公用文書とユーザガイドでは文章の性質が異なるので、流用できるルールのみ取り込んでいます。
ことばの研究｜NHK放送文化研究所（https://www.nhk.or.jp/bunken/research/kotoba/）
- すべてを読み込むというより、文章の書き方で複数の案が出て迷った時の参考に閲覧しています。
  話し言葉と書き言葉という差異が生じる可能性も加味しつつ、読んだ内容の一部を取り込むような使い方です。

記載したユーザガイドをセルフチェックしたり、他の方が書いた文章をレビューしたりする時には、以下のツールやサイトの力を借りることもあります。

常用漢字チェッカー｜常用漢字情報サイト（https://joyokanji.info/）
- 常用外漢字を探す時に使います。
  読みやすさの観点からも、漢字は過度に使いすぎたくない上、ユーザガイドであれば常用外漢字を使わないと成り立たない文章を書くこともないはずなので、常用漢字のみを残します。
文賢（https://rider-store.jp/bun-ken/）
- 表記揺れだけでなく、不自然な文章になっている箇所の指摘をしてくれます。
  正直なところ、使い始めたばかりのため、まだ使いこなすところまで到達できていません。
Microsoft Word　＞　ドキュメントの統計（https://support.microsoft.com/ja-jp/office/85b4969e-e80a-4777-8dd3-f7fc3c8b3fd2）
- 元ファイルがWordである場合に、ときどき使用します。
  テクニカルライティングというより、日本語の文章としての妥当性をはかるのに使うことがあるという程度の使い方です。