提示詞概覽
精選 AI 合作夥伴
給你的提示
當文件能解釋意圖與使用限制，而不僅是重述每行程式碼表面功能時，價值會大幅提升。
來自營運團隊NexusAi Technology解決的問題
開發者常因為將程式碼轉譯為可讀解釋費時費力而推遲撰寫文件。此指令幫助將函式、類別、模組或檔案轉化為清晰的技術解釋，方便隊友、未來維護者或合作夥伴理解。
意圖優先的程式碼解釋
解釋程式碼試圖達成什麼目標，使文件捕捉意圖而非僅重述語法。
依賴與使用釐清
揭示開發者在閱讀或重複使用程式碼時所需的關係、假設與整合點。
維護者導向的撰寫
產出的文件對未來的修改、除錯與入職比簡單的行逐行總結更具參考價值。
AI 提示詞指令
請扮演專精於開發者溝通與工程透明度的資深技術文件專家。
您的任務是將源代碼轉換為清晰、結構化的文件，解釋程式碼的功能、運作方式以及其他開發者安全使用或修改所需的知識。
背景：
我需要準確、易讀且對工程師有用的文件。它應解釋行為、重要邏輯、輸入輸出、依賴關係及使用考量，不應語意模糊或過度膨脹。目標是減少編寫文件所需的時長，同時提升未來開發與維護的效率。
輸入：
1. 程式碼片段、檔案、模組或函式
2. 語言或框架背景
3. 目標受眾
範例：內部開發者、初級工程師、入職隊友、技術利益相關者
4. 文件偏好
範例：簡潔的技術總結、行內解釋、文件頁面、模組參考資料
5. 任何已知的實施注意事項
輸出要求：
第 1 節 — 程式碼用途總結
解釋這段程式碼負責什麼。
第 2 節 — 功能分解
描述主要的邏輯部分或職責。
第 3 節 — 輸入、輸出與依賴關係
釐清程式碼接收、回傳及依賴的內容。
第 4 節 — 使用或整合說明
解釋應如何使用或其所屬位置。
第 5 節 — 重要注意事項
強調邊緣案例、假設或實施風險。
第 6 節 — 最終文件草案
產出一份乾淨、符合開發者閱讀習慣的文件區塊。
規則：
- 針對準確性與可讀性進行優化
- 避免無工程價值的模糊總結
- 使解釋對維護與移交具有實用性
- 保持最終輸出適用於真實文件工作
預期成果
一份乾淨的技術解釋，總結了程式碼用途、邏輯、輸入輸出、依賴關係、注意事項及最終可重複使用的文件草案。
實施流程
貼上真實的程式碼背景
輸入函式、檔案、模組或類別，並提供足夠的周邊背景。包含語言、框架與特殊注意事項，以確保解釋不偏離事實。
3–5 分鐘產出首個解說草案
在 ChatGPT、Gemini 或 Claude 中使用指令產出結構化解釋。確認 AI 描述的是對維護者重要的內容，而非僅是將語法翻譯成白話文。
5–8 分鐘針對目標受眾進行精煉
根據讀者是工程師、新隊友還是技術主管來調整草案，使同一段解釋能重複用於不同文件、入職筆記或內部參考。
5–10 分鐘