テクニカルライティング向けChatGPTプロンプトプレイブック
これらのプロンプト技法を使用して、テクニカルライティングの質と効率を向上させましょう。
対象は、これまで取扱説明書やマニュアルを作ったことのない初心者の方です。製品安全対策や、業界/社内ルールに適合する文はここでは記載していません。
精緻なドキュメントを作成するためのプロンプトは、ひとつのプロンプトへの回答で完成ではなく、繰り返し深掘りしていき、自分なりにほしい答えが見つかったらあらたにスレッドを立ち上げて聞き直す、ということを繰り返して精度を上げていくのがよいでしょう。
テクニカルライティング向けプロンプト基本例
基本1: ChatGPTに文書作成支援をさせる
プロンプト（ざっくりと聞く）
「ChatGPTが私のテクニカルライティングスタイルを学び、技術仕様書のイントロ部分を作成するための最適なプロンプトは何ですか？」
プロンプト（テキストを添付しつつ聞く）
「以下の文書を参考にして、私のテクニカルライティングスタイルを学び、技術仕様書のイントロ部分を作成してください。イントロは読者に技術的な背景を明確に伝え、簡潔かつ正確な言葉で構成してください。また、文章のトーンはプロフェッショナルでありながら、初心者にも理解できるようにしてください。」
基本2: 表形式で情報を整理する
プロンプト
「ソフトウェアツールの比較表を作成してください。以下の列を含めてください：ツール名、機能概要、対応プラットフォーム、価格帯。ここにまとめたいツールがあります：[ツール]」※[ツール]として資料を添付する。
基本3: 専門知識を持つ専門家としてのシミュレーション
プロンプト
「業界で10年以上の経験を持つテクニカルライターとして、初心者向けにクラウドコンピューティングの基本概念を説明する文書を作成してください。専門用語は最小限にし、具体的な事例を含めてください。」
基本4: 目次構成のたたき台を作成する
プロンプト（基準を指示して作る）
「〇〇に基づいた目次構成を作ってください」
例：「クラウドコンピューティングの入門ガイドに基づいた目次構成を作ってください。基本的な概念から実践的な応用までをカバーしてください。」
プロンプト（対象を指示して作る）
「〇〇を説明する文書の目次構成を作ってください」
例：「APIの基本と使い方を説明する文書の目次構成を作ってください。初心者向けに、APIの定義、仕組み、活用事例、注意点の順で説明してください。」
プロンプト（章立ての存在を指示して作る）
「〇〇のセクションに分けた目次構成を作ってください」
例：「ソフトウェアインストールマニュアルの目次構成を作ってください。セクションとして、インストール手順、設定方法、トラブルシューティング、FAQを含めてください。」
プロンプト（ざっくりとした構成を例示する）
「〇〇の観点で目次構成を作ってください」
例：「プロジェクト管理ソフトウェアの操作マニュアルの目次構成を作ってください。初心者向けの観点で、導入、基本操作、応用機能、よくある質問を含めてください。」
プロンプト（詳しく作ることを指示する）
「〇〇についての目次構成を詳細に作ってください」
例：「データセキュリティの技術ドキュメントの目次構成を詳細に作ってください。まず、基礎的な概念、次に技術的な仕組み、最後に実装手順をまとめる構成にしてください。」
基本5: 目次の構成要素を聞く
プロンプト（製品として聞く）
「〇〇マニュアルを作成する際に必要な構成要素を教えてください」
例：「新しいソフトウェアのユーザーマニュアルを作成する際に必要な構成要素を教えてください。基本的な操作手順からトラブルシューティングまで含めたいです。」
プロンプト（ターゲットユーザーを切り口に聞く）
「〇〇を対象にしたマニュアルの構成要素にはどのようなものがありますか？」
例：「初心者向けに書かれたクラウドサービスの導入マニュアルの構成要素にはどのようなものがありますか？わかりやすいセクションに分けたいです。」
プロンプト（機能を切り口に聞く）
「〇〇を説明するマニュアルに必要な主なセクションを教えてください」
例：「APIの使用方法を説明するマニュアルに必要な主なセクションを教えてください。セットアップから具体的な使用例まで網羅したいです。」
プロンプト（具体的な例を入れて聞く）
「〇〇のマニュアルには、どんな要素を含めるべきですか？」
例：「デバイスのハードウェア設定マニュアルには、どんな要素を含めるべきですか？設定手順、問題解決、メンテナンスのセクションが必要です。」
プロンプト（具体的な案を入れて聞く）
「〇〇のマニュアル構成を考える際に、どのような要素を含めるべきですか？」
例：「業務用ソフトウェアの操作マニュアル構成を考える際に、どのような要素を含めるべきですか？初心者から中級者向けに、設定、基本操作、機能の詳細などをカバーしたいです。」
基本6: 概念を説明するため、技術的トピックを解説する
プロンプト
「API（アプリケーションプログラミングインターフェース）の基本概念を分かりやすく解説するために、各要素を小さなセクションに分解して説明してください。各セクションは、初心者でも理解できるような内容でお願いします。」
基本7: 操作手順を作成する
プロンプト
「新しいソフトウェアインストールのための操作手順（ステップバイステップガイド）を作成してください。OS別に手順を分け、各手順にはスクリーンショットを追加する余地を残してください。」
基本8: 文脈と制約を利用した要約作成（リード文）
プロンプト
「企業向けのデータセキュリティの重要性に関する100語以内の要約を作成してください。法的要件を考慮し、専門用語は控えめにしてください。」
基本9: イラスト作成の指示文
プロンプト（1. 基本情報）
「クラウドサービス導入マニュアルの図解をお願いします。初心者向けなので、シンプルでわかりやすいスタイルにしてください。」
プロンプト（2. 図解の目的）
「この図解は、読者がクラウドサービスにアクセスし、アカウントを作成して利用開始する流れを視覚的に示すためのものです。段階的なプロセスを示すことで、どのステップを踏むべきかが一目でわかるようにしたいです。」
プロンプト（3. 具体的な内容）
「以下のステップを図で表現してください：
ユーザーがパソコンやスマートフォンを使って、ウェブブラウザからクラウドサービスのログインページにアクセスしている様子。
アカウント情報を入力している場面（メールアドレスとパスワード）。
サービスにログイン後、初期設定（プロフィールや言語設定）を行っている様子。」
プロンプト（4. スタイルの要望）
「イラストのスタイルは、シンプルで清潔感のあるフラットデザインを希望します。カラーは、青系や緑系の優しい色合いを基調とし、重要なアクション（クリックや入力）はオレンジ色で強調してください。」
プロンプト（5. その他の要望）
「キャラクターの表情はシンプルなものにして、図解全体が混み合わないように、余白を適度に使ってください。図解は全体的にポジティブで親しみやすい印象を与えるようにしていただけると助かります。」
テクニカルライティング向けプロンプト活用例
ソフトウェアマニュアル作成
「特定のソフトウェア機能について、ユーザーが初めて使う際に理解しやすい説明文を書いてください。図解も考慮した形式で。」
APIドキュメント作成
「このAPIのエンドポイントを説明するために、各パラメータの意味や使用例を明確に示してください。」
トラブルシューティングガイド
「よくあるエラーメッセージとその解決策を表形式で整理してください。エラーコード、原因、解決策の列を含めてください。」
いいなと思ったら応援しよう！
