資料庫 › 程式

技術文件撰寫指令

Q: 能用英文寫嗎？

在讀者欄加上「英文輸出」即可。

黃黃柏睿・技術編輯 ·被複製 350 次·最後更新 2026/06/09

適用模型ClaudeChatGPT

一句話結論把複雜的技術設計快速轉成清楚易懂的說明文件。

指令介紹

技術文件常常要麼寫得太簡略讓新人看不懂，要麼寫得太學術讓人不想看。這組指令會依你的文件類型與目標讀者，把技術設計轉成結構清晰、重點突出的說明文件，無論是 ADR、API doc、系統架構說明或 README，都能快速產出可用的初稿。

適用情境

ADR 撰寫API 文件系統架構說明README 撰寫

懶人貼上・複製就能用

已填好範例複製就能直接用

帶去 Claude 帶去 ChatGPT

▸ 想換成你自己的內容？點開填一填選填

文件類型

技術內容摘要

目標讀者

⬇ 匯出此指令 CSV

AI 指令庫編輯的話

編輯實測指令依讀者設定語言層次，加圖表加 FAQ 加維護建議，技術文件不只是備忘錄。這組「技術文件撰寫指令」是 Prompts 編輯團隊實測整理的程式 AI 指令（Prompt），適合用 Claude、ChatGPT 執行。複製上方指令範本即可使用，免費、免註冊。

模型實測對照

產出標準 ADR 格式：Title/Status/Context/Decision/Consequences，加 Mermaid 流程圖說明事件流、決策理由與取捨（優點：可追蹤、可重播；缺點：複雜度提升、學習成本）、FAQ（「為何不用 CRUD？」「如何除錯事件流？」）、維護建議（每季回顧適用性）。

實測（Claude）：ADR 格式加圖表加取捨加FAQ加維護，文件最有說服力也最完整。

產出技術文件草稿含架構說明與決策理由。

實測（ChatGPT）：快速產出可用初稿，適合快速記錄。