iT邦幫忙

2025 iThome 鐵人賽

DAY 23
0
生成式 AI

學都學了:GenAI 從試錯到實用的實驗筆記系列 第 23

Day 23 Portfolio: 文件規範架構

  • 分享至 

  • xImage
  •  

今日主題

進度回顧
Day 22 Portfolio: SDD 框架實驗

今日目標:建立開發規格框架後,今日預計完成:規格、過程、決策、日誌保存成 .md 之合理流程/文檔

文檔架構

文件列表

/docs

├── PROJECT_OVERVIEW.md # 專案簡介與願景
├── SDD_SPEC.md # 你的規格驅動開發文件
├── DOMAIN_GLOSSARY.md # 專案關鍵詞彙解釋(Run、Metric...)
├── ARCHITECTURE.md # 系統架構、資料流、技術棧
├── DEVELOPMENT_LOG.md # 開發日誌(日期+進度+決策)
├── SECURITY_CHECKLIST.md # 資安檢查文件
├── ADR/ # 架構決策紀錄(Architecture Decision Record)
│ ├── ADR-001-FRONTEND-FRAMEWORK.md
│ ├── ADR-002-DATA-SOURCE.md
│ └── ...
└── TODO.md # 下一步與任務清單

開發日誌(Development Log)

  • 日期
  • 思考紀錄
  • 問題/待解

資安檢查文件

1. 認證與授權(Authentication & Authorization)

項目 狀態 備註
所有 API 端點皆需經 Token 驗證 ?
GitHub / Supabase 金鑰未暴露於前端 ? 使用 .env 管理
第三方 OAuth 登入權限最小化 ? 待確認
使用者資料不存於 LocalStorage(僅 Session) ?

2. 資料安全(Data Security)

項目 狀態 備註
使用 HTTPS / TLS 1.2+ 傳輸 ?
無敏感個資(PII)儲存在公開 Repo ?
JSON / YAML 資料經 Schema 驗證後才可佈署 ?
檔案上傳具 MIME Type 檢查 ? 加入前端檢查

3. 自動化流程與金鑰管理(CI/CD & Secrets)

項目 狀態 備註
GitHub Actions 使用 Encrypted Secrets ?
無明文憑證出現在程式碼中 ?
部署時自動刪除暫存檔案 / Logs ?
Pipeline 有 Rollback 機制 ? MVP 階段略過

4. 網站內容安全(Frontend & Hosting)

項目 狀態 備註
使用 Content Security Policy(CSP) ?
禁止 Inline Script / Eval ?
外部資源使用 Subresource Integrity(SRI) ?
無敏感 API URL 暴露於前端 ?

5. 第三方服務風險

項目 狀態 備註
GitHub API 呼叫有 Rate Limit 檢查 ?
n8n workflow 具防暴露保護(Basic Auth / IP allowlist) ?
Supabase 權限設為 RLS (Row Level Security) ?
所有外部 webhook 已設簽章驗證 ?

6. 日誌與追蹤(Logging & Monitoring)

項目 狀態 備註
錯誤記錄集中化(ex: Sentry / Supabase Logs) ?
不記錄任何敏感欄位(如 token、email) ?
失敗 Run 會發 Slack 通知 ?
每日自動備份 portfolio.json ? Git commit

7. 最終檢查(Before Publish)

  • [ ] 所有 ? 項目已確認無風險
  • [ ] data/portfolio.json 經過 schema 驗證
  • [ ] .env 不包含測試用金鑰
  • [ ] 檔案大小 < 10MB、載入時間 < 3s
  • [ ] 通過 Lighthouse 安全性分數 ? 90


上一篇
Day 22 Portfolio: SDD 框架實驗
系列文
學都學了:GenAI 從試錯到實用的實驗筆記23
圖片
  熱門推薦
圖片
{{ item.channelVendor }} | {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言