Files
sdlc/templates/deliver-page.md
T

2.5 KiB
Raw Blame History

交付:{計畫名稱} {WP-nn} {工作包名稱}

  • 頁名:DELIVER_{HASH}
  • HASH:{HASH}
  • 對應分析:ANALYZE_{HASH}
  • 存取庫:{owner}/{repo}
  • 目標分支:{使用者確認的目標分支}
  • 工作證:TICKET_{yyyyMMdd}_{HHmmss}_{HASH}
  • 交付工作包:是
  • 交付型別:API 文件
  • 交付時間:{yyyy-MM-dd HH:mm:ss}

交付內容

項目 說明
這次交付什麼 {一句話講清楚接手者拿到什麼}
接手者需要做什麼 {下一步動作;沒有就寫「無」}
尚未交付的部分 {留在候補的實作工作包,或寫「無」}

API 文件

{方法} {端點路徑}

  • 端點狀態:本次新增
  • 說明:{這個端點做什麼}

標示規則:🆕 新增、⚠️ 變更、❌ 移除(含淘汰時程)、既有參數留空。 資料來源:真實:{來源} 或 推論:無來源。範例只留格式,個資不留值。

輸入參數(全部)

參數 位置 型別 必填 範例 資料來源 狀態
{name} path/query/header/body {型別} 是/否 {值} 真實:{來源} 🆕 新增

輸出參數(全部)

參數 型別 說明 範例 資料來源 狀態
{name} {型別} {說明} {值} 真實:{來源}

錯誤回應

狀態碼 條件 回應結構
{400} {條件} {結構}

新舊差異

  {方法} {端點路徑}
    {既有參數}      {型別}   {必填}
+   {新增參數}      {型別}   {必填}   {預設值}(本次新增)
-   {移除參數}      {型別}   {必填}   (本次移除,{日期} 前相容)
!   {變更參數}      {型別}   {必填}   (本次變更:{變更內容})

驗收條件

  • {可驗證的條件}

變更檔案

檔案 變更
{path} {做了什麼}

驗證方式

項目 指令或步驟 結果
{測試} {指令} {通過/失敗}

已知限制

  • {限制或風險;沒有就寫「無」}