iT邦幫忙

2026 iThome 鐵人賽

DAY 27
0

今天進入 Day 27,主要是整理整個專案,並開始編寫 README.md。

README 到底是寫給誰看的?
我整理後發現,README 不只是介紹作品,讓不同的人快速了解這個專案,也是給自己重新梳理自己做的成果。

  • 未來的自己:快速回想專案架構、功能和啟動方式。
  • 其他開發者或面試官:了解使用的技術、特色功能和開發成果。
  • 使用者:知道 App 可以做什麼,以及如何在本地端執行。
    整個流程看起來就像是下面這樣...
    專案原始碼 → 整理資訊 → 撰寫 README → 讓別人快速理解專案

整理 README 的內容
這次主要把 README 分成幾個部分,讓專案資訊比較完整。
1. 專案概述與核心功能

  • 整理 App 的主要特色,例如:
  • 明細搜尋與分類
  • Recharts 財務圖表
  • 夢想存錢目標
  • 歷史月報
  • 即時 API 匯率
    2. 技術架構
    把這 30 天實際使用到的技術整理出來,包括:
    React、React Router、Context API、localStorage,以及自己建立的 storage.js 安全防護機制。
    3. 快速開始與開發歷程
    除了整理安裝與啟動指令,也把 30 天的開發過程分成不同階段,讓整個專案從最初的基本記帳功能,到後來加入圖表、API、Router、資料同步等功能,都能被看見。

整理 README 其實也是整理自己
這次最大的感覺是,README 並不是單純「寫一份介紹文件」。
當我開始整理技術棧、功能和開發歷程時,也會重新思考:
「這個功能為什麼這樣做?」、「這個技術到底解決了什麼問題?」
所以這次比較像是把原本散落在程式碼裡的東西重新整理成一張完整的筆記,也像是這三十天的文章。

總結:

  • README 不只是作品介紹,也是專案的使用說明
  • 整理技術棧可以幫助自己確認對專案架構的理解
  • 把開發歷程整理出來,可以更清楚看見 30 天的變化
  • 文件整理也是重新檢查專案的一種方式
    把程式寫出來只是完成作品的一部分,能把自己的成果說清楚,也是一種能力。

明天我就會將專案正式部署上線,到時候就會附上線上網址,讓大家可以體驗。


上一篇
Day 26|localStorage 安全防禦與資料備援:讓資料保存更穩定
下一篇
Day 28|雲端部署:讓 React 記帳 App 正式上線
系列文
Vibe Coding 實戰手冊:30 天打造具備預算控管與數據視覺化的 React 記帳應用 共 29 篇
圖片
  熱門推薦
圖片
{{ item.channelVendor }} | {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言