---
tags: 軟體開發
---
[TOC]
# 版本號編號建議
## 軟體
* 以三碼為限制，以X.Y.Z為例
* X: 主版號-修改時表示不相容
* Y: 次版號-修改時表示仍相容，但有增加功能
* Z: 修訂號-僅錯誤修正，不影響功能時變更
* 以1.0.0為啟始版號
* 當前兩碼有進行變更時，變更碼其後的編號皆歸零
* ex:
* 1.1.5 -> 1.2.0
* 1.5.8 -> 2.0.0
* 開發中的版本為目前版號後加上.base.dev字樣，待進版時依照修改內容決定下一個版號
* ex:
* 目前版本 1.0.0
* 以1.0.0版為基底進行開發的開發中版號1.0.0.base.dev

## ~~文件~~
* ~~與軟體對等的文件以前兩碼做為對應~~
* ~~ex:~~
* ~~軟體版號 1.2.8~~
* ~~軟體文件版號 1.2.x~~
* ~~測試文件版號 1.2.x~~
* ~~第三碼為文件修改版本~~

## 文件版號與狀態
* 狀態可分為：relase, draft，文件檔名沒有加上狀態表示為release版本，如果是編輯中應加註draft
* ex:
* 討論中版號為當前版後後加符號 ex:當前版號為1.2.0 => 1.2.0-日期-draft
* release時依照與前版的差異程度來變更版號
* 假設為不相容的改版，則變更為 2.0.0
* 假設為新增功能的改版，則變更為 1.3.0
* 假設為修正錯誤的改版，則變更為 1.2.1

# 專案文件編碼

## 檔案名稱
### 檔案命名規則
每個欄位使用'-'隔開；亦即欄位內容不得再包含'-'
| 欄位 | 公司 | 專案號 | 文件號 | 文件名 | 模組/主題(可省略) | 版號 |
| ---- | ---------- | -------- | -------- | -------------------- | --------------------------- | -------------------- |
| 說明 | 固定為TIRC | 專案代碼 | 文件編碼 | 依文件統一命名 | 模組名稱或 文件名之外的補充 | 主版號 次版號 修訂號 |
| 範例 | TIRC | PMA3 | 00W01R | Component API Design | Incubator | 軟體v1.2.0 硬體v0.A.0 |

### 檔案編號範例
* 系統需求與測試報告
- TIRC-PMA3-00W01R-System Requirement Spec-Module-v1.0.2
- TIRC-PMA3-00W02R-System Requirement Spec-System-v1.0.3
- TIRC-PMA3-00W01R01-System Test Plan-Module-v1.0.x (意指PMA3-00W01R測試計劃)
- TIRC-PMA3-00W01R01#-System Test Report-Module-v1.0.x-20200424 (意指00W01R01報告)
- TIRC-PMA3-00W01R01#-System Test Report-Module-v1.0-20200425 (報告可能有多份)

* Incubator模組韌體文件(incubator編號為01)
- TIRC-PMA3-01F01D-SDS FW Protocol Define-Incubator-v1.0.3
- TIRC-PMA3-01F02D-SDS FW Component Design-Incubator-v1.0.5
- TIRC-PMA3-01F03D-SDS FW Error Description-Incubator-v1.0.2
- TIRC-PMA3-01F01D01-FW Integration Test Plan-Incubator Protocol-v1.0.1(01F01D的測試計劃)
- TRIC-PMA3-01F01D01#-FW Integration Test Report-Incubator Protocol-v1.0-20200425

## 文件號編碼規則

| 欄位 | 模組編號 | 功能分類 | 序號1 | 文件分類 | 序號2 | 記錄 |
| ---- | -------------------- | ------------------------------- | --------------------- | ----------------------------------------------------------- | ------------- | ------------- |
| 格式 | 2碼數字 | 1碼英文字 | 2碼流水號 | 1碼英文字 | 2碼流水號 | 1碼符號 |
| 說明 | 00：系統 01~99：模組 | E(EE) M(ME) F(FW) S(SW) W(複合) | 每個功能分類 獨立編號 | R(Requirement) D(Design) P(Project Process) | 測試的流水號 | #(表示為記錄) |

# 專案文件歸檔建議

* 歸檔位置：[SharePoint](https://tirc.sharepoint.com/sites/RDD/PRJ_DRAFT/Forms/AllItems.aspx?)
* 資料夾位置定義：專門放置正在規劃/開發/設計/驗證檔案的位置，提供共同編輯的一個平台
* 操作方式：檔案命名的原則遵守上述的規範
* 檔案說明：放置目前最新版本提供共同討論及共同編輯的文件，同一份文件僅能有一份存在於此
* 舉例：TIRC-MMA1-D132-SDS-Protocol Define-PLC-A2-v1.5.0-20210304-draft 與 TIRC-MMA1-D132-SDS-Protocol Define-PLC-A2-v1.4.1-20210226-draft 不會共同出現

## 文件歸檔方式

– (建立初版)

1. 新建立的文件【`TIRC-xxx-v0.0.0-建立日期-draft.docx`】存放於[sharepoints](https://tirc.sharepoint.com/sites/RDD/PRJ_DRAFT/Forms/AllItems.aspx?)
2. 直到release時，將文件<font color="red">**移動**</font>到<font color="green">[DOC資料夾]</font>
3. 並且將文件更改名稱為【`TIRC-xxx-v1.0.0.docx`】及<font color="red">**更新**</font>標頭
4. 將檔案轉存成pdf並存於<font color="green">[PDF資料夾]</font>中
5. 寄信通知所有參與專案同仁並附上該pdf檔案【`TIRC-xxx-v1.0.0.pdf`】

– (初版完成後，有變更需要時)

6. 再將word檔從<font color="green">[DOC資料夾]</font><font color="red">**複製**</font>回SharePoint，並更名為【`TIRC-xxx-v目前版本-日期-draft.docx`】
7. 若原本有前次修改的紅字，先改回黑色，接續修改時以紅字註明修改處
8. 直到release時，將文件<font color="red">**移動**</font>到<font color="green">[DOC資料夾]</font>
9. 依據進版原則修改檔案名稱【`TIRC-xxx-vx.y.z.docx`】及<font color="red">**更新**</font>標頭
10. 將檔案轉存成pdf並存於<font color="green">[PDF資料夾]</font>中
11. 寄信通知所有參與專案同仁並附上該pdf檔案，信中內容提及本次修改內容(複製Revision History即可)

### 文件歸檔方式附註
* 修改文件過程中請開啟追蹤修訂，Release成pdf前關閉
* <font color="green">[DOC資料夾]</font>位置：`\\192.168.158.21\tirc\ORG_RDD_ALL\專案文件\{專案代碼}\Doc`
* <font color="green">[PDF資料夾]</font>位置：`\\192.168.158.21\tirc\ORG_RDD_ALL\專案文件\{專案代碼}\PDF`
* 每次修改文件後輸出前，加入Revision History
* 初版：version 1.0.0、建立日期、修改者名稱、Major Change寫Draft
* 修改版：version x.y.z、今日日期、修改者名稱、根據追蹤修訂內容填寫Major Change
* <font color="green">[DOC資料夾]</font>與<font color="green">[PDF資料夾]</font>內只放置最新版的文件，前版皆移動至該資料夾中的archieve資料夾