SHOEISHA iD

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

DeveloperZine(デベロッパージン)- エンジニアの意思決定を支える技術情報メディア ProductZine

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

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

【超時短テクニカルライティング】生成AIを活用しながら文章を見直して、よりわかりやすい文章にしよう

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

効率的な見直しの手法とは

 初めからわかりやすい文章を書けるようになるのは、私の経験上かなり難易度が高いと言わざるを得ません。そこで現実的な対処方法として、初めからわかりやすい文章を書くのはいったん諦めて、自分が書いた文章を見直し、わかりにくい文章を修正していく方法を考えましょう。

 では、わかりにくい文章を効率的に発見するにはどうすればいいでしょうか。

 昔からよく使われている手法の一つとして、「三日寝かせる」という手法があります。簡単に言うと、日にちをおいて見直すという方法です。「三日寝かせる」とは、「自分の頭を寝かせる」ことが目的です。頭の中の情報や記憶をリセットしたうえで、あらためて文章を読み直すと、「無意識のうちに補完しながら読んでしまう」ことを避けることが期待できます。完ぺきに忘れることはできませんが、「三日寝かせる」ことで、文章の誤りや抜け漏れ、論理の飛躍に気づきやすくなります。

 もう一つの手法は、「同じ内容を異なる表現で書いた2つの文章を作り、比較する」ことです。左の文章を考える場合を例にすると、以下の2つの文章を比べるイメージです。

 (1)表現が違う2つの文章を作り、比べることです。

 (2)同じことを説明している異なるバージョンの文章を比較することです。

 この2つの文章は同じことを表現しようとしています。そして、この2つの文章を比べながらわかりやすい文になるように、再構築します。その途中で私は、(1)の文には「同じ内容」という情報が抜けていることに気が付きました。また、(2)の文には「作る」という情報が抜けています。

 このように2つの文章を比較することで、誤りや、論理の抜け漏れなどを効率的に発見できます。一つの文章だけを丁寧に見直すよりも、異なるバージョンの文を比較すると、効率的に問題を発見できるいい例だと思い、紹介しました。

 「比較する」手法自体は以前から存在するものですが、生成AIを利用すると、自分が書いた文章と同じ内容で、表現が異なる文章を簡単に作成できます。

 ここで紹介する生成AIを使った作業の流れは、以下のとおりです。

  1. 原稿を作成する
  2. 生成AIで別の表現の文章を生成する
  3. 比較検討する
  4. 最終版を完成させる

 では順番に見ていきましょう。

生成AIで別の表現の文章を生成する

 自分が書いた文章の内容を変えずに、異なる表現の文章を簡単に作成するにはどうすればよいでしょうか。ここでは、そのために活用できるプロンプトを紹介します。

 「プロンプト」とは、生成AIに指示を出すための文章のことです。例えば、「この文章の誤字を修正して」と指示を出すと、AIがそれに従って修正を提案してくれます。

 今回紹介するプロンプトは、単なる校正ではなく、異なる表現の文章を作成することも目的にしたものです。第1回の記事で紹介した「校正」の手法をさらに発展させたものであり、誤字・脱字や表記のゆれを修正しつつ、新しい言い回しも生成できる一石二鳥のプロンプトになっています。

プロンプト例:

ドキュメントを作成しています。あなたは経験豊富なテクニカルライターとして、誤字・脱字、表記の揺れ、文法の誤りなどを確認し、修正してください。

 

以下の点に注意して校正を行ってください。

- 表記の統一、表現の統一、文法の微修正

- 句読点やスペースの調整(特に半角文字の前後にスペースは不要です)

- 一文一義の原則を守る

- 冗長な表現や不要な接続詞を削減する

- 主語と述語の対応を明確にする

- 読者が一読で理解できるように、適切に言い換える

- 正しく理解できる語順にする

- 二重否定を使わない

- 修正結果は、コードブロックに入れる

以下は禁止事項です。

- 構成を変更しない

- 情報を増減させない

"""

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

"""

 禁止事項としてあげた項目は、「同じ内容を異なる表現で書いた2つの文章を作り、比較する」という目的を達成するために書いてあります。説明の順序 (構成) を変更したり大幅に情報を増減したりすると、「比べる」という目的を達成することが難しくなります。それを避けるために書いています。

 このプロンプトを使うことで、生成AIが原稿の内容を理解した上で修正を行い、異なる表現の文章を生成します。

生成AIに操作手順を作成させる

 ここは余談になりますが、テクニカルライターとして操作手順を書くときに、気にしていることをプロンプトにしてみました。もし操作手順を書くようなことがあれば、このプロンプトを試してみていただけると、ソラコムらしい操作手順になると思います。みなさんが書いている操作手順にあわせて少しアレンジして使っていただけると幸いです。

プロンプト例:

ドキュメントを作成しています。あなたは経験豊富なテクニカルライターとして、テクニカルライティングで推奨されている形で操作手順を書いてください。以下の点に注意して修正してください。

- 箇条書きや表を利用する。

-文体 (ですます調、である調) は種類ごと (見出し、本文、操作手順) に統一する。見出しと本文は文体を変えても良い。

- ユーザーの操作と、システムの動作を明確に区別する。特に、能動態、受動態を使い分けて、視点に一貫性を持たせる。

 - ユーザーが行う操作を能動態 (〜します) で書く。手順は 1.、2. のように手順番号をつける。ユーザーの操作はすべて書く (省略しない)。例:**作成**をクリックします。

 - ユーザーが行う操作は「クリックします」や「選択します」のように操作を明確にします。「画面を開きます。」は目的であって操作ではないので不適切です。

 - システムやSORACOMの動作を受動態 (~されます) で書く。手順番号を付けない。インデントをつける。なお、システムの動作は省略しても良い。

  - 良い例: 「〇×画面が表示されます。」と書く。

  - 悪い例:「システムは〇×画面を表示する。」や「画面に〇×が表示されます。」とは書かない。受動態で書けば読み分けられるので、「※」や「-」などの記号を使わない。

 - 能動態の文と受動態の文は別の行にする。

- 使役形を使用しない。

- 時制を統一する。

- 修正結果は、コードブロックに入れる。

以下は禁止事項です。

- 文章の意味を変えない。

- 専門用語を勝手に置き換えない。

- 文章の構成を大きく変更しない。

"""

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

"""

 ちなみに、1つのプロンプトに多くの注意事項を含めると、いかに生成AIでもすべてを正しく対応することが難しくなります。そのため注意事項が増えたときは、いくつかのプロンプトに分けることが効果的です。

次のページ
文章を比較して完成させる

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

生成AIを活用!超時短テクニカルライティングのススメ連載記事一覧

もっと読む

この記事の著者

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

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

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

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

CodeZineは、株式会社翔泳社が運営する開発者のための情報メディアです。日々の開発に取り組むエンジニアやテクノロジーを学びたい方に向けて、プログラミングやAI活用、開発ツール、エンジニアの学びとキャリアに関する記事をお届けしています。

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

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

この記事をシェア

CodeZine(コードジン)
https://codezine.jp/article/detail/20895 2025/03/07 11:00

イベント

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

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

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

メールバックナンバー