設計書、仕様書、Wiki、社内ドキュメント……。
IT現場では技術的な情報共有が必須ですが、「結局これ、何が言いたいの？」という文書に出会ったことはありませんか？
今回紹介するプロンプトは、専門的な内容を“誰にでもわかるように言い換える”ためのAIツールです。
エンジニア自身が使っても良し、ドキュメントレビューにも最適。伝わる技術文書を効率的に作れます！
プロンプトを使うメリット
このプロンプトを使うと、下記のメリットがあります。
- 「結局何が言いたいの？」を回避できる
- ドキュメントの読み手が増え、情報共有がスムーズに
- 技術者が時間をかけてリライトしなくてよくなる
- マネージャー・営業・他部署との橋渡しがしやすくなるになる
こんな人におすすめ
- ソフトウェアエンジニア（バックエンド／フロントエンド）
- テクニカルライター
- QAエンジニア（テスト仕様書の作成者）
- PM（開発要件の説明・翻訳担当）
- 社内ドキュメントを整備しているエンジニアリングマネージャー
利用シーン
- 設計書や仕様書を非エンジニアにも理解できるようにリライトしたいとき
- Wiki・ナレッジベースを読みやすくしたいとき
- 社内レビュー時に「誰でも読める文章」に整えたいとき
- テスト仕様や運用手順書を外部共有用に直したいとき
プロンプト内容
下記の手順通りに画像生成AIツールに入力をしてください。
プロンプト（指示文）の使い方
- 生成AIツールにを開き、以下のプロンプトをコピー＆ペーストする
- ＿＿欄を入力する
- 生成AIツールにメッセージ
実際のプロンプト
送信例を、内容に合わせて自由に変更・削除してお使いください。
今回はChatGPTへ送信した回答例を紹介します。
プロンプト内容例
#依頼
以下の技術的な文章を、ITに詳しくないメンバーにも伝わるように、やさしく丁寧な日本語に言い換えてください。
#役割
あなたは技術に精通しつつ、非エンジニアにもわかりやすく説明できるテクニカルライターです。
読み手が「なるほど」と思える表現でリライトしてください。
#制約
専門用語には簡単な補足を添えてください。構成は見出し＋本文。全体で400〜600文字以内。
#データ
原文：「このAPIは、認証トークン（JWT）をHTTPヘッダーに付与してリクエストを送信する必要があります。トークンが無効または期限切れの場合、401 Unauthorizedが返されます。」
Chat GPTの回答
■ APIの使い方について（やさしい説明）
このAPIを使うには、ログイン後に発行される「認証トークン（JWT）」をリクエストのヘッダーという部分に付けて送る必要があります。
このトークンは「あなたはちゃんとログインしている人ですよ」という証明書のようなものです。
もしそのトークンが古くなっていたり、間違っていたりすると、サーバー側から「認証エラー（401 Unauthorized）」という返事が返ってきます。
その場合は、もう一度ログインし直して新しいトークンを取得してから使ってください。
まとめ
技術者には当たり前の言葉も、他の職種には難しい。
でもこのプロンプトを使えば、「伝える」までの距離が一気に縮まります。
伝わる技術文書は、チーム全体の仕事を加速させますよ！
