跳至主要內容

開發紀錄

把「我做過」整理成「讀者可以帶走的方法」

用日期欄位和 404 筆記作編輯示例,練習從完成紀錄選出讀者問題,保留能解釋判斷的細節,再把案例整理成可使用、也有適用邊界的方法。

林予晴
發布
  • 公開筆記
  • 寫作方法
  • 編輯
  • 開發紀錄

「新增日期欄位,驗證通過。」是一則能交接進度的紀錄,但還不是一篇文章。

讀者不一定正在參與同一個專案。他需要知道的是:日期混在一起會造成什麼判斷困難、拆開之後由誰使用,以及什麼情況不該照抄這個做法。

我整理本站筆記時,會把工作紀錄當成素材,不把完成順序直接當成文章順序。要留下的,是別人遇到相似問題時,也能拿來檢查或作決定的內容;不是把每一項做過的工作都公開一次。

從完成事項,換成讀者正在猶豫的問題

完成事項以工作為中心:「加了什麼、修了什麼、接了什麼」。文章題目則要先決定,讀者為什麼需要知道這件事。

例如,本站已經有一篇日期欄位的筆記。它不只列出 authoredAt、publishedAt 和 updatedAt,而是把三種內容事件分開,說明寫成文字不等於已可公開,公開後的更新也不是第一次發布。

下面是一組編輯示例,不是原始工作紀錄的逐字引用:

完成紀錄式寫法 改成讀者問題
加入三個文章日期欄位 一個日期能不能同時代表寫稿、發布與更新?
加入自訂 404 頁 錯誤畫面出現了,就代表未知網址真的回傳 404 嗎?
修正內容列表查詢 同一篇文章,為什麼在首頁看得到,在列表卻沒有?

換成問題後,文章就有了取捨依據。日期篇不必重講整站建置,404 篇也不需要順便教完所有 HTTP 狀態碼。

這一步還不是改出一個吸引人的標題而已。如果正文仍然照著「先改這個、再改那個」往下貼,讀者問題並沒有真的改變結構。

選出會改變判斷的細節

把文章寫成方法,不等於把具體細節全部拿掉。

如果只保留「欄位責任要清楚」,讀者仍然不知道怎麼判斷。日期篇裡,publishedAt 參與公開資格與排序,authoredAt 不作發布日期 fallback,這些細節才解釋了為什麼不能隨便合併欄位。

相對地,當時先打開哪個檔案、用了幾次搜尋、修改發生在哪個分支,通常不影響讀者理解這個選擇。它們可以留在工作紀錄,不必搬進正文。

我會用一個刪除檢查:拿掉這個細節,讀者是否更容易作出錯誤決定?

  • 拿掉發布條件,可能讓人以為寫完就能公開,所以要保留。
  • 拿掉「日期不會自動觸發靜態網站重建」,可能讓人誤以為已有排程,所以要保留。
  • 拿掉某次內部交接的檔名清單,並不影響上述判斷,就沒有必要占用正文。

這是本文採用的編輯判準,不是量測過的閱讀效率公式。細節有沒有用,要看它能否支持文章的主要問題。

案例往外推時,要保留成立條件

最近的 404 筆記有一個具體觀察:本機直接請求 404.html 回傳 200,請求不存在的網址則回傳 404。

從這個案例可以整理出一個檢查方法:分開測錯誤文件和未知路徑,同時讀取狀態碼與內容。這個方法不要求讀者使用相同品牌、相同圖片或相同文章資料。

但不能再往外寫成「所有主機直接開錯誤頁都會回傳 200」,也不能宣稱正式網域已經通過驗證。案例發生在本機 preview,尾端斜線還有不同分支,這些條件都限制了結論。

我會把推導整理成以下關係:先交代案例中實際看到什麼,再說這支持哪個判斷,最後留下讀者在自己環境需要重做的檢查。

真正能帶走的,不一定是某個結果;有時是「不要用這個結果證明另一件事」的辨識方法。

改寫成可以執行的一小段方法

工作紀錄往往已經有材料,只是缺少能讓外部讀者使用的順序。可以先拿一則紀錄填出下面這張編輯卡:

讀者遇到的情境:
他需要決定或檢查什麼:
案例裡可核對的觀察:
這個觀察支持的判斷:
讀者可以重做的最小步驟:
不能沿用或仍需確認的條件:

以 404 案例來說,情境是正在驗收靜態網站的未知網址處理。最小步驟不是「建立一個好看的錯誤頁」,而是選一個確定不存在的路徑,讀取它的回應,再確認錯誤內容和恢復入口是否正確。不同主機的 fallback 行為,則必須在各自環境驗證。

這張卡是本文提出的整理方式,不是本站另外新增的工具或內容 schema,也不要求每篇文章都把它原封不動印出來。填不出其中幾項時,先回去補素材或縮小問題,比替空白寫一段泛泛的結論有用。

它和開發需求卡的方向也不同:需求卡用來決定接下來要做什麼,這裡則是從已有證據中,選出值得對外解釋的判斷。

沒有新的判斷,就不必再拆一篇

同一次開發可以產生多篇文章,但不能只靠換標題區分。

例如,「建置通過不等於網站完成」和「工具通過了什麼,就只能證明什麼」,如果最後都只列出相同工具、相同限制和相同例子,就沒有多出一個讀者問題。

這時可以把新材料補進既有文章,或先留在候選清單。反過來,404 篇雖然也談驗證,卻有自己的操作差異:直接讀錯誤文件和請求未知路徑,會得到不同狀態碼。這個案例可以形成更窄、可重做的檢查,不必再次列完所有開發工具。

判斷要不要成篇時,我會把新稿的讀者問題、主要證據和最後能做的事,與既有文章並排。三者如果都只是換句話說,先不新增文章。

這不是篇數控制公式,也不代表每則紀錄都欠一篇公開內容。尚未確認的產品、不能公開的素材,或只有結果沒有過程的片段,都可以繼續留在內部。

拿掉作者名字後,文章還剩下什麼

最後回讀時,可以暫時遮住作者和專案名稱,看看段落是否仍然清楚:讀者知道面對什麼情境,知道為什麼選這個做法,也知道要到哪裡觀察結果。

如果剩下的只有「我完成了很多事」,就還需要回到素材;如果刪掉所有具體內容後只剩「重視品質、保持彈性」,則是抽象得太遠。

本站的作品卡片與筆記篇談的是兩種內容入口各自負責什麼。這篇補的是寫作時的動作:先選讀者問題,挑出影響判斷的細節,再留下可以重做的檢查與限制。

這些編輯示例沒有加入新的個人經歷、讀者研究或成效數字,也不能證明讀者已經理解或採用了方法。它們讓文章的用途可以被檢查,不讓用途只依賴作者說自己做過。

下一次整理紀錄時,不必先決定要寫多長。先拿一則已確認的工作,寫出讀者會在哪個地方需要判斷;找不到那個地方,就先保留紀錄。