本記事の著者
株式会社ソラコム テクニカルライター 矢崎 誠
SORACOMのドキュメントをメンテナンスしたり、生成AIを利用するSORACOM Support Botを開発したりしているテクニカルライター。アベイズム株式会社→有限会社ビートラスト（フリーランス）→LINE株式会社→株式会社ソラコムと何度か転職はしていますが、社会人になって約25年間、常にテクニカルライターです。最近は生成AIに面白さを感じて開発成分増量中。「LINE社内で大評判のテクニカルライティング講座で説明した内容をあらためてブログにまとめてみた」の著者。
はじめに
私は、株式会社ソラコム（以下、「ソラコム」）でテクニカルライターを務める矢崎です。ソラコムのテクニカルライターは、自らドキュメントを整備するだけでなく、ソラコムのメンバーによるドキュメント作成の支援も行っています。第3回の今回は、生成AIを活用して文章を見直すテクニックをご紹介します。
本連載「超時短テクニカルライティング」では、短時間で高品質なドキュメントを作成するためのアイディアを紹介しています。IT製品のマニュアルや仕様書を作成する方はもちろん、その他のドキュメントを作成する方にも役立つ内容です。ぜひ実際に手を動かしながら読み進めていただければと思います。
今までの連載の流れは、以下の通りです。
| 回数 | 内容 |
|---|---|
| 第1回 | 生成AIを活用し、従来とは異なるアプローチでドキュメントを執筆する方法を紹介 |
| 第2回 | 「ドキュメントの構成」に着目し、理解しやすい文章を作成する方法を紹介 |
| 第3回 | より細かい単位である「文」に焦点を当て、生成AIを活用する方法を紹介 |
対象読者
本連載の対象読者は、業務でドキュメントを書くエンジニアです。エンジニアであれば、何らかのドキュメントを書く機会があるでしょう。そのため、本連載はすべてのエンジニアが対象になると考えています。
自分の文章を見直すのは意外と難しい
連載の第1回、第2回の手法を使って、ドキュメントに書くべきことが整理され、説明の流れ（＝構成）が整理できたとすると、次に攻略するのは一文のわかりやすさです。しかしながら、みなさんもご存じのとおり、わかりやすい一文を書くのは、想像以上に難しいものです。
例えば、あとで見直してみたら主語と述語がかみ合っていなかったり、主語や前提の説明が抜けていて何を説明しているかわからない文になったり、主語が途中で変化していたり、主語が何度も登場したりなどです。こういったことは、（恥ずかしながら）テクニカルライターが文章を書いていてもよく発生します。
私はその理由の一つが、文章を書いているときに頭の中に生まれる「豊富なアイディア」を漏れなく文章にできないことにあると考えています。つまり、考えた内容のごく一部だけが文章となり、その結果、主語などの重要な情報が文から抜け落ちたり、逆に重複したりして、わかりにくい文章になってしまうのです。
さらに、自分で書いた文章を見直して修正することは簡単ではありません。例えば、執筆直後に文章を読み返しても、頭の中のアイディアや執筆時の記憶が残っているため、無意識のうちに、文章にない情報を補完しながら読んでしまいます。その結果、誤りや論理の飛躍に気づきにくくなるのです。
