技術文書を「前提知識ゼロ」の人向けに噛み砕く
専門用語だらけの技術文書を、その分野を知らない人にも伝わる言葉に置き換えて整理する
こんなときに使えます
エンジニアが書いた技術資料を他部署に共有しなければならないが、専門用語だらけで自分も半分しか分かっていない。読み手を指定して噛み砕かせるのがこのプロンプトです。元の文書にない機能や効果を勝手に足させないので、社内共有に使えます。
以下の技術文書を、{読み手(例:新入社員、他部署の担当者)} にもわかるように噛み砕いて説明してください。
{技術文書の本文}
## 作成ルール
1. 専門用語が出てきたら、初出時に一言で言い換えを添える
2. 全体の流れを「何のためのものか→どう動くか→注意点」の順で整理する
3. 元の文書にない機能や効果を勝手に付け加えない
技術的に不正確にならない範囲で、たとえ話を1つ入れてください。
実際の出力例
このプロンプトを実行すると、次のような結果が返ってきます(内容は例です)。
【何のためのものか】
社内の複数システムに散らばっている顧客情報を、1か所から検索できるようにする仕組みです。各システムのデータをコピーするのではなく、必要なときに元のシステムへ問い合わせに行く方式を採っています。
【どう動くか】
1. 利用者が検索窓に顧客名を入力する
2. 仕組みが、営業システム・請求システム・問い合わせ履歴の3か所に同時に問い合わせる
3. 返ってきた結果を1つの画面にまとめて表示する
※API(エーピーアイ):システム同士が情報をやり取りするための窓口のことです
【注意点】
・元のシステムが停止していると、その分の情報は表示されません(キャッシュ=一時保存の仕組みは持っていません)
・検索できるのは顧客名と電話番号のみです。住所での検索には対応していません
精度を上げるコツ
- 読み手を「新入社員」「営業担当」のように具体的に指定してください。ここで言い換えの水準が決まります。
- 噛み砕いた結果を、元の資料を書いた人に一度見せてください。簡略化の過程で不正確になった箇所は、書いた本人にしか気づけません。
- 「注意点」の節が空なら、元資料に制約が書かれていない可能性があります。導入判断の前に確認すべきサインです。
使い方:プロンプト内の{変数}の部分をご自身の内容に書き換えてお使いください。
