SHOEISHA iD

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

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

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

【超時短テクニカルライティング】生成AIを活用してドキュメントの構成をわかりやすく整える方法

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

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

生成AIを使って情報の漏れを検知する

 2ページ目のプロンプト例で出力されたアドバイスに従っていると、だいたい構成が整うと思います。

 そして、アドバイスに従って情報を並べ替えたり、書き換えたりするときに、ある情報とほかの情報の間に大きな隙間があることに気が付くかもしれません。具体的には、以下のように本来は「あ」「い」「う」「え」の順に並ぶのが期待されるのに、少し考慮が漏れていて図のように「う」が抜けてしまうことに気が付くというケースです。

情報が抜けてしまったドキュメント例
情報が抜けてしまったドキュメント例

 同様に、網羅的に書いていたつもりが、一つだけ抜けていたことに気が付くこともあるかもしれません。ここではそれを「情報の漏れを検知した」と表現します。

 読者がドキュメントを読んでいて「どういうわけか突然わからなくなったな…」とか「理解しているつもりだけど不安だな…」という負の感情に襲われるのは、「情報の漏れ」が存在するときか「誤った説明」が書かれているときです。「誤った説明」については、がんばって正しさを追及するしかありませんが「情報の漏れ」については、生成AIにある程度検知してもらうことができます。具体的には以下のプロンプトで検知できる可能性が高いです。こちらもぜひお試しください。

プロンプト例:

ドキュメントを作成しています。あなたは経験豊富なテクニカルライターとして、情報の漏れがないか確認してください。考慮する点は以下のとおりです。

### 対象読者の知識と執筆者の知識のギャップ

対象読者の知識と、執筆者の知識にギャップがあると、「わかりにくい」と感じやすいドキュメントになります。そこで、対象読者の知識と執筆者の知識にギャップがある場合は、そのギャップを埋める方法を提案してください。

### 説明間のギャップ

ドキュメントの中で説明されている内容が、丁寧に順番に説明されていると考えていますが、対象読者の知識では飛躍している(ギャップがある)と感じるかもしれません。説明間にギャップがある場合は、そのギャップを埋める方法を提案してください。

### 網羅性の確認

説明を書いているうちに、いままで考慮していなかった新しいパターンに気が付くことがあります。たとえば、生卵とゆで卵の話を書いていたら、半熟卵や温泉卵のことも書きたくなった、というようなケースです。同じようなケースが存在しないか確認してください。漏れがある場合は、その漏れを補う方法を提案してください。

### 特別なケースについての言及

標準的な説明がすべて漏れなく書かれていたとしても、特別なケースについてはまだ漏れがあるかもしれません。たとえば、現金で利用料金を支払おうとしたときに、現金を受け付けてくれない店舗であったり、現金が財布に入っていなかったりするケースは、特別なケースです。また、注意しなければいけないことや、逆に知っておくとうれしくなるようなことも、特別なケースのひとつです。このドキュメントでもそのような特別なケースに関して考慮漏れがないか確認してください。考慮漏れがある場合は、どのような情報を追加すればよいか提案してください。

### ほかの情報との関連性

このドキュメントの内容を正しく素早く理解するために、ほかの情報が大きく役に立つことがあります。そのようなケースがないか確認してください。大きく役に立つ情報があれば、提案してください。

現在の原稿は以下のとおりです。

"""

(ここに原稿を貼り付ける)

"""

 これで「情報の漏れ」をある程度検知できると思います。説明の順番が整って、情報の漏れが検知されなくなれば、いい感じのドキュメントになっていると言えるのではないでしょうか。

ひと工夫:イメージ図や表、スクリーンショットを追加する

 今回の記事の最後に、one more thing、もうひと工夫を入れてみましょう。たとえば、文章だけでは伝えられないものがないか、イメージ図や表、スクリーンショットなど、視覚的にわかりやすさを届ける工夫ができないか、生成AIの意見を聞いてみましょう。

プロンプト例:

ドキュメントを作成しています。あなたは経験豊富なテクニカルライターとして、読者の理解を促進するためにイメージ図や表、スクリーンショットなど視覚的に強い情報を挿入できないか検討してください。考慮する点は以下のとおりです。

### イメージ図

複数のコンポーネント(名詞とも言えます)が登場する説明の場合、コンポーネント(名詞)間の関係がわかりにくくなります。そのようなときはイメージ図を挿入することを提案してください。もし可能なら具体的なイメージも提案してください。

### 適切な量の表や箇条書き

複数の情報を比較したり、対比させて説明したりする場合、表や箇条書きを使うとわかりやすくなることがあります。そのような情報が原稿に含まれていないか検討し、適切な量の表や箇条書きを利用できる箇所を提案してください。

### スクリーンショット

スクリーンショットが理解を助けるケースがあります。そのような場合は、スクリーンショットの挿入を提案してください。どのような目的でスクリーンショットを挿入するかを説明すると、執筆者が作業しやすくなります。

 

現在の原稿は以下のとおりです。

"""

(ここに原稿を貼り付ける)

"""

 生成AIのアドバイスに対して、具体的にどのように対応すればよいかイメージできなかった場合は、引き続き生成AIと対話して、サンプル画像を書いてもらうとよいでしょう。ちなみにこの原稿に含まれる図表は、生成AIのアドバイスに従って挿入したものです。実際に読者の皆さんの理解を促進する図表になっているのではないでしょうか。

まとめ

 この記事では、生成AIを活用してドキュメントのわかりやすさを向上させるテクニックを紹介しました。第1回でも書きましたが、生成AIはそれらしい記事を生成することに長けていて、とても便利に見えます。

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

 特に「確認すべき点」をプロンプトに残せることはとても価値があると感じています。次に同じプロンプトを利用してさらに時短できますし、新しいアイディアをプロンプトに入れることで、より高品質なドキュメントを作る助けになるかもしれません。このように、生成AIと人がそれぞれの強みを発揮できるノウハウを蓄積していきましょう。

 ちなみにこの記事も、今回紹介した方法で生成AIと一緒に作りました。いかがでしょうか。今回の記事の感想など、X(@yazakimakoto)宛てにお聞かせいただけると幸いです。次回は、文章の言い回しのチェックを生成AIに依頼する方法を紹介する予定です。お楽しみに!

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

  • X ポスト
  • このエントリーをはてなブックマークに追加
生成AIを活用!超時短テクニカルライティングのススメ連載記事一覧
この記事の著者

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

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

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

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

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

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

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

この記事をシェア

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

おすすめ

アクセスランキング

アクセスランキング

イベント

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

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

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

メールバックナンバー

アクセスランキング

アクセスランキング