首頁/規劃工具/API 文件中文提示詞:請 AI 整理端點與錯誤格式
規劃工具開發流程

API 文件中文提示詞:請 AI 整理端點與錯誤格式

輸入 API 目標,整理成可貼給 AI 的 API 文件提示詞。

這裡產生的是完整提示詞。請複製後貼到你的 AI 工具,讓 AI 根據你的專案整理規劃內容、待補問題與下一步行動。

完整提示詞

貼給聊天型 AI

你是一位資深產品經理、技術文件寫作者與軟體交付顧問。請根據以下資訊,幫我產生「API 文件中文提示詞:請 AI 整理端點與錯誤格式」需要的完整內容。 專案名稱:客戶管理系統 目標: 讓小型團隊管理客戶資料、追蹤狀態並匯出報表 請用繁體中文輸出,並遵守以下要求: 1. 先用新手能理解的語言說明這份規劃內容的用途。 2. 文件內容要能直接拿去跟工程師、AI Coding 工具或客戶溝通。 3. 不要只列標題,每一段都要有可執行的內容。 4. 如果資訊不足,請用「待補問題」標出,不要自行假設成事實。 5. 請把「AI 根據現有資訊做出的假設」獨立列出。 6. 請把內容分成清楚區塊,包含: - 背景與目標 - 使用者與情境 - 功能範圍 - 不包含項目 - 驗收標準 - 技術或工具需求 - 風險與注意事項 - 下一步行動 請最後附上一段「我接下來應該怎麼使用這份文件」。

TL;DR

API 文件要讓前端、後端、AI Coding 工具或外部客戶知道如何呼叫、會回什麼、錯誤怎麼處理。

必要內容

列出路徑、方法、驗證方式、請求資料、回傳資料、錯誤碼與範例,避免只寫端點名稱。

相關服務官方連結

服務名稱都連到官方網站;採用前請再確認方案、地區限制、商業使用條款與最新價格。

PostmanAPI 文件與測試

API 開發與測試平台,適合整理端點、範例請求、集合與文件。

有免費與付費團隊方案。

GitHub程式碼協作

程式碼版本管理與協作平台,幾乎是現代軟體交付的基本工具。

有免費與付費團隊方案。

先看懂這些名詞

常見問題

這些結果可以直接拿去跟客戶報價嗎?

可以當作討論起點,但正式報價仍要依需求細節、整合難度、驗收方式與維護責任調整。

我是完全新手,應該先看工具還是名詞解釋?

先用工具取得方向,再點進結果裡的名詞解釋。這樣比較容易把抽象詞彙對應到真實決策。

你可能也需要

規劃工具產品規劃

技術選型中文提示詞:請 AI 比較適合你的工具組合

依產品類型、市場、付款與 AI 需求,整理成可貼給 AI 的技術選型提示詞。

推薦邏輯

工具會用產品型態、資料複雜度、登入需求、付款需求與維運能力做初步判斷。

立即使用
規劃工具客戶交付

客戶交接中文提示詞:請 AI 產出交付文件

輸入專案名稱與交付目標,整理成可貼給 AI 的客戶交接提示詞。

交接重點

列出 GitHub 程式碼倉庫、部署平台、資料庫、身份驗證、權限控管、付款、Email、監控的負責人與付款方式。

立即使用