---
# System prepended metadata

title: 技術文件範例

---

# 技術文件範例

更新時間：
編輯人員：
相關技術：`babylon.js V2, blender V5`
定期檢閱：

摘要說明：

這是一份技術文件範例檔，描述了撰寫技術文件的目標和進行方式，還有注意事項及各項相關的連結資訊。

## 撰寫技術文件的目標

方便後來的人接手和讓其他人知道
- 方便找到：資料位置、資料的歸納方式、歸納方式說明
- 方便知道：技術面的 know-How，什麼是什麼，技術名詞（採用什麼套件）
- 方便跟進：技術面的處理流程，例 3D 場景建置的流程
- 方便理解：
    - 採用某種處理方式和技術的考量要點
    - 過去討論過的重點、原因、結論，才有了現在的做法

## 帳號名稱和位置

- 路徑位置：https://hackmd.io/team/virsody
- 文件類別：Private
- 官方帳號：service@bkhole.com
- 團隊名詞：Virsody Dev Team


## 具體的進行方式

為了避免大家去整理過去的東西造成太大的負擔，目前採用在【開發新功能】的時候做：
- 流程記錄：記錄操作步驟和注意事項
- 設計記錄：採用某技術或實作時的考量
- 討論記錄：討論結果的決策緣由及指標

## 其他注意事項

- 技術文件是給團隊內部人士看，若要給外部人士，會由專人整理另外提供
- 有任何不清楚或想知道怎麼撰寫的部分，歡迎找阿泰討論