本記事の著者
株式会社ソラコム テクニカルライター 矢崎 誠
SORACOMのドキュメントをメンテナンスしたり、生成AIを利用するSORACOM Support Botを開発したりしているテクニカルライター。アベイズム株式会社→有限会社ビートラスト（フリーランス）→LINE株式会社→株式会社ソラコムと何度か転職はしていますが、社会人になって約25年間、常にテクニカルライターです。最近は生成AIに面白さを感じて開発成分増量中。「LINE社内で大評判のテクニカルライティング講座で説明した内容をあらためてブログにまとめてみた」の著者。
はじめに
私は、株式会社ソラコム（以下、社名を「ソラコム」と表記します）で、テクニカルライターとして働いている矢崎です。ソラコムは、IoT（モノのインターネット）向けの通信プラットフォーム「SORACOM」を提供する企業です。SORACOMを通じて、デバイスの接続や管理を効率的に行えるソリューションを提供しています。
ソラコムのテクニカルライターは、自分でドキュメントを整備することはもちろん、ソラコムのメンバーがドキュメントを整備することも手伝っています。
この連載では「超時短テクニカルライティング」と称して、私がドキュメントを作成するときのアイディアをいくつか紹介します。普段、IT製品のマニュアルや仕様書などのドキュメントを作成している人はもちろん、それ以外のドキュメントを作成するときにも役立つ内容です。ぜひ最後まで手を動かしながら読んでいただけると幸いです。
対象読者
本連載の対象読者は、仕事でドキュメントを書くことがあるエンジニアです。ドキュメントを書かないエンジニアはいらっしゃらないと思いますので、ほぼすべてのエンジニアの方が対象になると思います。
ドキュメントの整備の重要性
私は専門職としてドキュメントを毎日書いていますが、みなさんもドキュメント作成を頻繁に行っているはずです。例えば、マニュアルや仕様書だけでなく、日報や議事録などを含めると、ドキュメントを書いたことがない方はほとんどいないと思います。そして、さまざまなドキュメントを書くたびに、もっと効率よく進めたいと感じることがあるのではないでしょうか？
テクノロジーが進化し、多くのツールが利用できる現代でも、ドキュメントの作成には依然として時間と労力が必要です。しかし、どれだけ時間と労力が必要でもドキュメントの整備は欠かせません。
ドキュメントは、技術的な内容を読者（ユーザーに限らず、チーム、上司、部下なども含みます）に正確に伝え、多くの人の「道しるべ」となる重要な存在です。これがしっかりと整備されていれば、ドキュメントを読むだけで疑問は解決し、大きな時間がかかることなく仕事や作業が進んでいくことが期待できます。
もちろんドキュメントを読むだけですべてが解決することは難しいでしょう。しかし、ドキュメントがあれば、関係者がドキュメントを見ながら話をすることで、短い時間で状況を理解していくことができるでしょう。
逆にドキュメントが不安な品質だと、問題が生じたときにそれを解決するために必要な情報を集めるところから始めなければいけないなど、後々の問題解決に大きな時間がかかることが考えられます。
このように重要で価値があるドキュメントの整備について、私たちはいま生成AIを活用して効率化することに挑戦しています。この記事では私たちが挑戦している手法を紹介しています。最後まで読めば、ドキュメントの質を保ちながら、スムーズにドキュメントを書くためのアイディアが得られると思います。
今回紹介する手法は「人が持つ知見を有効活用する」を基本としていますので、普段、IT 製品のマニュアルや仕様書などのドキュメントを作成するときはもちろん、それ以外の日報などのドキュメントにも応用できると思います。ぜひ一緒に、超時短テクニカルライティングに挑戦していきましょう！
