Markdown
Markdown 標記語法
Markdown 用少量符號排版純文字。這些符號可建立標題、清單、連結和程式碼區塊。
另一個例子
團隊只寫一份 README。GitHub 會排好版,終端機和程式碼審查也能清楚閱讀。
主要部分
- 01被測程式或行為
- 02可觀察證據
- 03覆蓋、失敗與復原
什麼時候用
適合用於指南、Issue 範本、版本說明或有結構的 AI 提示。
什麼時候不要用
文字要在多種工具一致呈現時,避免使用平台專屬語法。
程式裡的名稱
CommonMark / GitHub Flavored Markdown 上線前要檢查
檢查程式執行環境與版本、整合邊界、相依套件與授權,以及支援的平台。驗證安全、失敗處理、效能與監控。也要檢查部署、支援負責人、升級路徑與回復上一版的方法。
預期成果:把 Markdown 標記語法 (Markdown) 當成團隊能維護的技術基礎,並檢查它是否符合產品需求。 使用者情境:團隊只寫一份 README。GitHub 會排好版,終端機和程式碼審查也能清楚閱讀。 技術或工程概念:Markdown 標記語法 (Markdown)。 適用理由:適合用於指南、Issue 範本、版本說明或有結構的 AI 提示。 不應使用的情況:文字要在多種工具一致呈現時,避免使用平台專屬語法。 工程適配:定義程式執行環境與版本。說明它負責什麼、介面、資料流、相依套件、支援平台、安全與效能限制,以及如何接上現有技術組合。 生命週期防護:檢查相依套件是否健康、授權是否可用。加入監控與安全退路,並指定升級負責人。沒有可衡量的好處時,不要再加入功能重複的框架或工具。 驗收條件:用最小整合證明必要行為。測試相容性、安全性、失敗與效能。記錄部署、升級、支援與回復上一版的方法。 證據與限制(證據邊界):正式文件仍可能是草案、候選版或最終版。請查看文件狀態,也要確認瀏覽器或平台是否支援。 待確認:現有技術組合、執行環境、版本規則、目標平台和相依套件負責人。也要確認效能預算、支援期限與搬移限制。
檢查這份需求
請 AI 程式助手檢查目前如何使用 Markdown 標記語法 (Markdown)。 定義:Markdown 用少量符號排版純文字。這些符號可建立標題、清單、連結和程式碼區塊。 正式環境檢查:檢查程式執行環境與版本、整合邊界、相依套件與授權,以及支援的平台。驗證安全、失敗處理、效能與監控。也要檢查部署、支援負責人、升級路徑與回復上一版的方法。 修改程式前,先列出看到的證據、缺口、嚴重程度,以及最小且安全的修正。