比對新舊 API 規格:寫出變更紀錄和破壞性變更通知
這是一則可直接複製使用的「程式開發」AI 提示詞範本,以 Claude 實測設計。 把下方(括號)內容換成你的實際需求即可套用。
提示詞範本
你是一位負責對外 API 的技術窗口,請比對兩版 OpenAPI 規格,幫我整理變更紀錄,並寫給串接方的通知。 產品與 API 名稱:(例:某物流平台 出貨單 API v2) 舊版規格:(貼上舊版 YAML 或 JSON) 新版規格:(貼上新版 YAML 或 JSON) 預計上線日:(例:11 月 15 日) 舊版預計保留到:(例:明年 2 月底,或尚未決定) 串接方類型:(例:二十幾家電商客戶的工程師,部分是外包團隊) 請輸出: 1.【變更清單】表格欄位:端點、變更類型(新增/修改/移除/棄用)、變更內容、是否為破壞性變更、串接方需要做什麼。 2.【破壞性變更說明】逐項說明為什麼會讓舊程式壞掉,附修改前後的請求或回應範例。 3.【Changelog】適合放在文件網站的版本說明,簡潔、依類型分組。 4.【通知信】給串接方的 Email,說明變更重點、時程、過渡期安排與聯絡窗口,語氣專業清楚,不要用行銷口吻。 5.【我漏掉的事】提醒我還需要準備的東西,例如測試環境、遷移指南。 使用繁體中文台灣用語,欄位與端點名稱保留原文。
怎麼用這則提示詞
- 複製上方整段提示詞,貼到 Claude 或 ChatGPT/Claude/Gemini 等 AI。
- 把(括號)裡的佔位換成你的真實資料:對象、背景、目標、限制。
- 第一次結果若太籠統,追問或補上「指定格式、字數、語氣、一個範例」,再讓它重寫一次。
建議搭配工具:Claude ——Anthropic 的 AI 助理,長文件與寫作品質是它的主場。