核心工作流程06 / 16
閱讀說明與依據
本頁內容
實作說明讓你從一段意圖出發,理解程式碼如何運作,並找到支持說明的依據。閱讀時著重行為、支持資料,以及仍需你判斷的問題。
開啟段落與局部說明
點選文件文字可編輯。點選段落內文字以外的空白處,則會開啟標示為 L1 的段落級說明。
部分說明針對某個詞或片語。將游標移到段落上會顯示短底線,點選即可閱讀標示為 L2 的局部說明。
清單、表格與程式碼區塊也可有說明。整個清單會一起調查,標題不單獨調查。
你可以同時開啟多個段落的側註。每個段落一次顯示一份段落級或局部說明。視窗較窄時,側註可能顯示在段落下方。
閱讀三個區塊
| 區塊 | 回答的問題 | 閱讀重點 |
|---|---|---|
| 實作 | 實作如何回應這段意圖? | 行為、步驟、邊界情況與實作選擇。 |
| 依據 | 什麼支持這份說明? | 程式碼引用、測試、命令輸出及其他可檢查資料。 |
| 注意事項 | 哪些事情仍需判斷? | 缺口、實作選擇、風險與建議。 |
實作預設展開;需要時可展開依據。沒有注意事項時,該區塊會隱藏。
以連續簽到 7 天獎勵為例,說明可能描述日期如何累積、引用相關函式與測試,並提示跨時區旅行的處理方式。實際內容取決於對專案的調查。
檢查依據
程式碼引用會以系統預設應用程式開啟檔案。圖片可在側註中檢視與放大。命令輸出、程式碼差異等資料標籤會開啟新分頁。資料若已不可用,Noea 會告知。
確認每份引用是否回答你的問題、測試涵蓋哪些條件,以及結果是否支持結論。缺少關鍵情境時,針對段落提問,要求進一步調查或驗證。
尤其要區分三種依據:
| 資料 | 能協助確認 | 不能確認 |
|---|---|---|
| 實作或測試程式碼 | 使用的邏輯及測試定義的情境。 | 有測試不代表已執行或通過。 |
| 過去的執行結果 | 當時執行了什麼,以及當時的結果。 | 後續程式碼變更可能讓結果不再適用。 |
| 本次實際執行的驗證 | 本次環境與範圍內的執行結果。 | 已涵蓋情境通過,不代表未測試情境也正確。 |
解釋與調查通常讀取程式碼及現有依據,而非每次重跑測試、建置或應用程式。當單靠閱讀無法確認影響判斷的關鍵事實時,才會視需要驗證。請依實際執行內容判斷驗證範圍。
若要重跑特定測試,在對話中請 Agent 執行並回報範圍與結果,再重新調查相關段落。
決定哪些選擇應納入意圖
說明寫著「目前實作使用本機儲存」,是在描述現行方式,不代表未來版本必須沿用。希望持續保留的需求應寫入意圖文件。
考慮選擇是否影響使用體驗、成本、隱私、風險或未來決策。理解後,常見的決定有兩種:
- 目前方式可接受,但希望未來保有調整空間:繼續使用,不把它設為限制。
- 未來版本也必須維持:明確寫出需求,並審閱它帶來的限制。
例如,你目前可以接受簽到紀錄使用本機儲存。若離線使用變得必要,寫下「沒有網路時使用者仍可簽到」,再調查實作如何支援。描述所需行為,通常比複製詳細實作說明更容易維護。
理解注意事項
注意事項分為缺口、實作選擇、風險與建議,用來區分缺失行為、目前設計選擇,以及值得進一步討論的主題。
段落右側的注意標記可開啟相關說明。數字計算的是含有注意事項的說明面板數量,而非個別問題數。存在缺口時,標記顏色會更醒目。
先理解影響,再決定修正程式碼、補充驗證、修改意圖,或保留目前行為。並非所有注意事項都要成為需求。沒有標記只表示目前說明未列出注意事項。
探索行為示意
部分說明包含小型互動行為示意。你可以操作、重設,或檢視其原始碼。
示意在隔離沙箱中執行,無法存取應用程式或網路,也不會儲存互動狀態。它用來解釋規則;要確認真實軟體是否遵循,仍須檢查程式碼與驗證依據。
確認說明是否仍適用
先前的文字表示說明對應編輯前的意圖。可能已過時表示說明讀取或引用的檔案在調查後改變。兩者都值得再次調查。
側註為唯讀。要改變需求,請編輯意圖;要檢查說明,請使用調查或重新調查。參閱保持說明更新。