SHOEISHA iD

※旧SEメンバーシップ会員の方は、同じ登録情報(メールアドレス&パスワード)でログインいただけます

CodeZine編集部では、現場で活躍するデベロッパーをスターにするためのカンファレンス「Developers Summit」や、エンジニアの生きざまをブーストするためのイベント「Developers Boost」など、さまざまなカンファレンスを企画・運営しています。

生成AIを活用!超時短テクニカルライティングのススメ

【超時短テクニカルライティング】生成AIを活用してドキュメントを書く流れを掴もう!

生成AIを活用!超時短テクニカルライティングのススメ 第1回

  • X ポスト
  • このエントリーをはてなブックマークに追加

超時短テクニカルライティングの流れ

 ここまででようやく前説が終わりました。おつかれさまでした。ここから「超時短テクニカルライティング」の説明をしていきましょう。

 一般的にドキュメントを書く工程では「書くことの全体像を見通したうえで細部を書いていく」という方法が推奨されています。この方法は二度手間が無くなるなど、さまざまな点で効率が良いと考えられているからです。実際、私も全体像を見通したうえで細部を書いています。

 しかし、「書くことの全体像を見通す」ことにつまずく方も少なくないのでは?と私は考えています。この記事では、以下の手順でコンテンツを作成することを提案します。

  1. (全体像を見通すことなく)書きたいことを始めに書きます。
  2. 生成AIにアドバイスを求めます。
  3. アドバイスに従って修正します。
  4. 2〜3を繰り返します。
  5. 生成AIに校正を依頼します。
  6. 完成!

 つまり「書くことの全体像を見通す」のではなく、細部の「書きたいこと」から書いていくという提案です。

 「それならひょっとしたら書けるかも…?」と思ったあなたも、「そんなことで効率よく書けるわけない!」と思ったあなたも、ぜひ一度試していただきたいと思います。

伝えたい内容や解決したい問題を書き出す

 最初のステップでは、あなたが伝えたい内容や解決したい問題を書き出しましょう。箇条書きでもキーワードでも構いません。キーワードがひとつも出てこない場合は、周りの人と話をしてヒントをもらいましょう。ここでのポイントは、内容を深く考えすぎず、まずは自由に書き出すことです。もちろん、全体像は考えなくても大丈夫です。

 ある程度の個数の箇条書きやキーワードが揃ってきたら、以下のようなポイントを押さえて、さらにキーワードを見直したり、要点を再整理したりしてみましょう。

  • 読者が抱えている問題は何か。たとえば、操作マニュアルであれば「ある機能の操作がわからない」「2つの機能の違いがわからない」のようになるでしょう。議事録であれば「会議に出ていないので内容がわからない」「決定事項が曖昧なので確認したい」のようになるかもしれません。
  • 読者が抱えている問題をどのように解決できるか。「ある機能の操作がわからない」であれば、その機能の操作をドキュメントに書くことになるでしょう。
  • 重要な技術的なポイントや注意点は何か。「機能の操作を書く」のであれば、その機能を利用するうえで、頭の片隅に入れておかなければ損をすることや、知っていると得することを書くといいでしょう。

 初めは「自由に書き出すこと」も難しいかもしれません。単語レベルでも何か書いてあれば次に進みましょう。

 この記事は、もちろん超時短テクニカルライティングの方法で書いています。初めに私が残したメモ(原稿の種のようなもの)は、以下のようになっていました。これはまだ「プロンプト」にはなっていないことに注意してください。

メモ(原稿の種)の例:

生成AI時代のテクニカルライティング

## はじめに

テクニカルライティングは、「(ここにイイ感じの文章を入れる)」ということです。

0~100まですべてを人間が書くのではなく、生成AIの力を借りて、効率よくドキュメントを書いていきたい。以下の手順を繰り返すことをおすすめする。

- 書きたいことを始めに書きます。

- 生成AIにアドバイスを求めます。

- アドバイスに従って修正します。

## 書きたいことを書く

箇条書きでも単語レベルでも良いので書きたいことを書きます。細かいところは生成AI に補ってもらいましょう。

## 生成AIにアドバイスを求める

以下のようなプロンプトを使って、生成AIにアドバイスを求めます。これまでに評価の高かったドキュメントと、自分が書きたい内容をセットで渡すのがポイントです。

```

(プロンプトを紹介)

```

## アドバイスに従って修正する

生成AIは、プロンプトに従っていい感じのアドバイスをくれると思います。あなたの知見をフルに生かしてアドバイスに従って修正しましょう。

生成AIにアドバイスを求める

 前のステップで書いた「書きたいこと」を生成AIに伝えます。このときにプロンプトを工夫すると、生成AIの出力の質が向上することが期待できます。

 以下は簡単なプロンプト例ですが、このように書くことで、生成AIが効果的なフィードバックを提供してくれるでしょう。カッコで囲まれているところは、みなさんが書きたい内容にあわせてアレンジしてください。

 書きたい内容だけでなく、どのようなトーンやスタイルで文章を生成してほしいかも指定しているところがポイントです。たとえば、専門的な技術文書を書く場合には、フォーマルかつ簡潔な文体を「参考にするドキュメント」として提供したり、具体例やケーススタディを含めるように指示したりすることで、より実用的な出力が得られるはずです。

プロンプト例:

テクニカルライティングに関する文章(どういった文章を書きたいか概要を説明)を書きたいです。

以下の内容に基づいて、専門的かつわかりやすい文章を書く予定です。文章を仕上げるだけでなく、なぜそのような文章が必要なのかを教えてください。

ポイントは、「生成AIの活用による効率化について(ここに主題を書く)」を説明することです。

"""

(ここに「書きたいことを書く」で書いた内容を貼り付ける)

"""

また、参考にするドキュメントは以下のとおりです。

"""

(ここに、これまでに評判が良かったドキュメントの内容を貼り付ける。これで、生成AIが出力するドキュメントのフォーマットが、以前のドキュメントに似たものになります)

"""

アドバイスに従って修正する

 前のステップでプロンプトと一緒に書きたいことを生成AIに伝えると、アドバイスがもらえると思います。ひょっとしたらガラッと書き換えてくれるかもしれません。これをそのまま使えるか…というと、残念ながらそうはいきません。

 生成AIは多くのデータからさまざまな知識を学んでいるため、それらしい文章を生成しますが、多くの人が同意できる一般的な内容が生成される傾向があります。強いて言うなら、「基礎的な情報を書く」ことや「参考にするドキュメントに形式を合わせること」に優れていると言えます。逆に少しネガティブな言いかたをすると、表面的で情報量が少ないコンテンツを生成する傾向があるとも言えるかもしれません。

 しかし、読者が求めるのは具体的かつ精密な情報です。(この記事が求められているのも同じだと思います。)そこで、生成AIが提案した内容に、自分が持っている専門的な知識や独自の視点、具体的な経験をうまくブレンドする形で修正していくことが大切です。具体例を加えたり、より正確で詳細な技術情報を追加したりすることで、ドキュメントの質が向上するでしょう。

 さらに、生成AIが提示した新しい表現やアイディアが自分の考えを広げることもあります。一人でコンテンツを作成するときにはうっかり見逃してしまった重要なポイントや、気が付きにくい新しい視点を提示してくれる場合もあります。

 以上のような観点をもって、生成AIのアドバイスに従って原稿を修正してみましょう。初めのメモと比べると、かなりよい感じのドキュメントに近づいたのではないでしょうか?

 そして、修正できたら一つ前のステップ「生成AIにアドバイスを求める」に戻って作業を繰り返しましょう。さらに新しい視点が提供され、書ける内容が少しずつ増えていき、少しずつ精密になっていくことが期待されます。

生成AIに校正を依頼する

 ある程度情報が整ってきたら、次のステップです。今度は「校正」を依頼しましょう。「校正」は、原稿に誤字脱字や誤記、内容の不備などがないかを確認し、修正する作業のことです。具体的には、以下のようなプロンプトを使うことが考えられます。

プロンプト例:

だいぶできあがってきたと思います。全体を通して、以下の記事を読んでください。

 - 校正してください。たとえば、誤字、脱字、情報の重複、冗長な部分が無いか、などの観点でチェックしてください。

 - 足りない情報を探してください。記事の初めのほうを読んで「自分のための記事だ」と感じている読者にとって、「テクニカルライティング」はなじみがないと考えられます。そういった読者にとって論理の飛躍がないか、予期せぬ用語が登場していないか、などの観点でチェックしてください。以下が原稿です。

"""

(ここに「できあがった原稿」を貼り付ける)

"""

 これを生成AIに送信することで、生成AIが新しい視点のアドバイスを出力してくれます。ここでもまたアドバイスに従って修正してみましょう。

 もし、不足している情報が見つかったときは、改めて「生成AIにアドバイスを求める」を行ったり「生成AIに校正を依頼する」を行ってみるのもひとつの手です。繰り返し生成AIと相談して、品質を上げていき、みんながあっと驚くようなドキュメントを短時間で完成させてしまいましょう!

 これが「超時短テクニカルライティング」の大きな流れです。ぜひ試していただければと思います!

ひと工夫:効率をさらに引き上げるコツ

 生成AIと対話を続けていると、生成AI自身が生成した内容の影響で、著者であるみなさんが同意できないようなことを繰り返し出力することがあります。そのようなときは、新しいチャットを始めると良いでしょう。これは、一人の人と相談していると煮詰まってしまうときに、ほかの人にアドバイスを求めることと同じです。人と相談しているときは、ほかの人にアドバイスを求めるのはハードルが高いかもしれませんが、生成AIに対してはそのような気遣いは無用です。

 生成AIも新たな気持ちでコンテンツを読み、新しい視点のアドバイスを生成してくれることが期待できます。もちろん、いままでのアドバイスに沿わない内容もあるかもしれません。そこはグッとこらえて、新しい視点のフィードバックを受け入れてみましょう!(これも人にアドバイスを求めているときによくあることだと思います(笑))

まとめ

 この記事では、生成AIを活用して、テクニカルライティングのプロセスを大幅に効率化するテクニック「超時短テクニカルライティング」の概要を紹介しました。生成AIはそれらしい記事を生成することに長けています。

 しかし、そのままでは一般的で価値のないドキュメントになりがちです。価値あるドキュメントを作るには、人の手による修正や補完が必要です。これを生成AIの弱点と捉えるのではなく「人の弱点を補うための生成AIの強み」と捉えられれば、より適切に自信をもって生成AIを活用できるのではないでしょうか。

 ここで説明した方法を実践することで、質の高いテクニカルライティングを、より短時間で効率的に行えるようになると信じています。実際にみなさんがドキュメントを作成するときに試してみていただけると、私もこの記事を書いた甲斐があるというものです。X (@yazakimakoto)宛てに感想もぜひお聞かせください。

 生成AIが提供する提案を最大限に活かしつつ、専門知識や経験を加えて最適なドキュメントを作り上げましょう。

 初めにも書きましたが、この記事は、今回紹介した「超時短テクニカルライティング」の方法で生成AIと一緒に作り上げています。この記事を読みやすく感じ、さらに価値があると感じていただけたら幸いです。次回は、プロンプトを発展させて、生成AIに構成の検討を依頼する方法を紹介する予定です。ぜひご期待ください。

この記事は参考になりましたか?

  • X ポスト
  • このエントリーをはてなブックマークに追加
この記事の著者

CodeZine編集部(コードジンヘンシュウブ)

CodeZineは、株式会社翔泳社が運営するソフトウェア開発者向けのWebメディアです。「デベロッパーの成長と課題解決に貢献するメディア」をコンセプトに、現場で役立つ最新情報を日々お届けします。

※プロフィールは、執筆時点、または直近の記事の寄稿時点での内容です

株式会社ソラコム(ソラコム)

ソラコムでは、アイディアやパッションを持つあらゆる人がIoTテクノロジーを活用できるようにする「IoTの民主化」をミッションに、IoTプラットフォームSORACOMを提供しています。デバイス通販サイト SORACOM IoT ストアでは、実績あるIoTデバイスを1個から提供、必要な機材一式と手順の書かれた<...

※プロフィールは、執筆時点、または直近の記事の寄稿時点での内容です

この記事は参考になりましたか?

この記事をシェア

  • X ポスト
  • このエントリーをはてなブックマークに追加
CodeZine(コードジン)
https://codezine.jp/article/detail/20474 2024/12/16 11:00

おすすめ

アクセスランキング

アクセスランキング

イベント

CodeZine編集部では、現場で活躍するデベロッパーをスターにするためのカンファレンス「Developers Summit」や、エンジニアの生きざまをブーストするためのイベント「Developers Boost」など、さまざまなカンファレンスを企画・運営しています。

新規会員登録無料のご案内

  • ・全ての過去記事が閲覧できます
  • ・会員限定メルマガを受信できます

メールバックナンバー

アクセスランキング

アクセスランキング