幫專案文件做一次整體保鮮
檢查文件之間、文件與實際程式碼是否一致,交付成套的修訂稿。本站整理 · 附 OpenAI 參考資料 · 來源核對日期:
參考依據與借鏡內容
- 讓文件與實際行為保持一致
參考用實際程式碼與可信來源核對文件、保留結構並驗證修訂;文件地圖、跨文件一致性和單輪交付範圍由本站補充。
請對目前專案的文件做一輪整體保鮮,找出文件之間以及文件與實際實作之間的不一致,交付能直接採用的修訂內容。 先從根目錄 README、文件索引和 docs 等現有目錄建立文件地圖,區分現行指南、專題說明、歷史紀錄與自動產生的內容。主動辨識執行、設定、發布、除錯等主要使用路徑,不讓我指定檔案。沿這些路徑關聯閱讀相關文件及必要的程式碼、設定和腳本定義,不以單篇文件為上限;歷史材料只用於追溯,不把歷史狀態當作目前事實。 重點核對:不同文件對同一指令、設定、路徑或流程的說法是否一致;說明是否與實際程式碼對應;操作步驟有沒有缺少前提;入口是否遺漏重要指南;本機連結是否存在。以專案目前的實作和可查證的第一手來源為依據,不能憑文件更新時間或措辭較新就判定哪一份正確。外部連結打不開時標為未驗證,不直接判為失效。不要執行安裝、發布、資料變更或刪除指令來核對說明。 優先完成會讓人操作失敗或理解錯誤的修訂,將同一問題涉及的多份文件一起核對、一起給出一致的候選改法。每項附檔案位置、原文、依據與影響,直接交付完整替換段落或可套用的修補檔(patch);短文件可給完整修訂稿。不只列問題清單,也不做缺乏效益的全庫潤飾。無法確認的事實保留並標註,不把待實作或待驗收的功能寫成目前事實。 如果文件很多,先涵蓋主要使用路徑和互相衝突的文件,其餘列入未檢查範圍;不要按固定篇數隨意截斷,也不要宣稱已讀完全部材料。完成一輪後複查各項修訂之間是否一致、路徑與指令是否有效,交付文件地圖、已完成的修訂和未驗證項目,然後結束。 執行約定: 直接開始,不先給計畫讓我確認,也不要讓我選檔案或補填範本。只用目前專案、目前對話及我已提供的材料,不搜尋其他專案或私人歷史。缺少材料時完成有依據的部分,在結果中說明缺口;完全不適用就說明原因並結束,不虛構成果。 保留現有檔案和未提交的改動;候選內容在回覆中完整給出,適合獨立成文的成果可另存為不重複檔名的新檔案。不要安裝相依套件、修改環境、提交、推送或發布。遇到權限或存取限制,記錄未完成項目,不繞過限制。自我檢查一次後交付並結束,不用「是否繼續」收尾。