開發者文件 從 0 到 1

為什麼需要寫開發者文件？

  1. 檔案結構爆炸 （NTCH）
  2. 功能、邏輯、Issues 容易找不到人問
  3. 紀錄重構、寫 Code 的眉角
  4. 前後端的資訊交流平台
  5. 會議記錄、各種紀錄
  6. 專案交接
  7. 時程規劃

寫文件的優點

  1. 方便交接、救火
  2. 掌握整體進程、各自工作量和進度
  3. 紀錄開發中的細節（如 Refactor 、Issues、 Breaking Change）
  4. 其他瑣碎資訊（如中英文對照表、參考檔案）

只要超過兩人協作，有文件就能省下跟其他人再講一遍的時間

總目標

藉由這份文件能讓大家清楚掌握負責專案的細節

需要時也能自由地在各專案之間遊走、支援，隨時救火

過程中碰到的問題也能知道找到對應的負責人詢問

寫文件的缺點、疑慮

  1. 撰寫耗時
  2. 沒人寫，也沒人看
  3. 該記什麼？怎麼記？
  4. 多人同時編輯混亂？

具體還是要之後大家實際操作、嘗試去抓到平衡

開發者文件應該包含哪些東西？

  1. 專案基本資料
  2. 資料夾建置架構
  3. 開發進度 / 時程、會議記錄
  4. 重構紀錄、Issue 紀錄
  5. 中英文對照表
  6. 重大更新、其餘參考檔案
  7. 商業邏輯

使用 Notion 來撰寫 開發者文件

Notion 是什麼？

他們自己說自己是一個
「把文件、知識庫、任務，無縫整合的現代工作平台」

而裡面是隨時可以打散、可以重組的各種「內容區塊」

Notion 能做到什麼？

  1. Markdown語法

  2. 以Block區塊為單位，自由重組排版

  3. 多種不同型態的Block區塊可使用（打 " / " 就會顯示所有型態）

    1. 一般型態（標題、清單、展開、註記、連結）

    2. 媒體型態（圖片、網頁縮圖連結、影音連結、程式碼、檔案）

    3. 嵌入 Google Drive、Google Map、Tweet

  4. 模板Template 可供複製

  5. 可與 Slack 連動發通知

Database 功能

可以各種形式呈現資料，並有 filter ,  sort 等功能

形式有 Table , Board , Gallery , List , Calendar

（ 待會 Demo ）

個人寫 Code 小小心得分享

  1. 先想過一遍架構再開始寫

    1. 避免寫到一半架構大改、邏輯想錯就直接下去

    2. 想過一遍也能確保自己真的懂程式的運作流程

    3. 需設定時間限制，不然會走火入魔迷失自我

  2. 想架構的過程中，盡量列檔案結構

    1. 把要建的檔案做成 checkbox

    2. 過程中有想到什麼也＋checkbox

    3. 開 PR 前就透過這個確認檢查一遍（提供SOP）

事不宜遲，直接上 Demo！

Made with Slides.com