撰寫一份好寫又好懂的Spec | 食品添加物合法業者資訊網

2019年5月20日—混亂的Spec是可怕的，設計混亂錯誤、不斷地重公浪費工時。一份條理分明的Spec也可幫助開發...條理化的排版也可幫助工程師秒懂規格甚至更好開發。

一、 前言

Spec文件(Spec)為系統中的環節，孰輕孰重。

在少人且溝通暢通團隊中，Spec文件也許看似不那麼重要(常常是口頭上確認)。但設計人員若是邊開發邊想，容易造成前後設計不一致的景況。Spec也具有依循紀錄的角色。

而在多人開發的團隊中，一份好的Spec可讓開發人員或測試人員快速的明白功能範疇、此隻功能內容，也可讓後來新加入的團隊人員有跡可循。

混亂的Spec是可怕的，若是排版混亂，原本清楚的規則，卻讓開發團隊看了許久還不懂，需不斷地花時間確認；若為Spec混亂錯誤，敏銳的開發人員為了寫好程式邏輯還須debug Spec中的牛頭不對馬嘴錯誤，並且不斷地重工，消耗了專案時程。若開發人員沒發現，整隻功能做錯，白做工的景況更是造成恐怖的Spec混亂開發錯誤局面。

因此，一份條理分明的Spec可幫助開發團隊快速易懂功能內容，是快速開發專案的重要因素。

二、常用的撰寫方式

以下就一些Spec撰寫經驗，主觀的分享筆者認為好的Spec所具備的要素：

1.         清爽乾淨的排版，增加Spec的易讀性

1.1.   編碼排版整潔，清楚的大綱標題：

一致性排版：在撰寫不同份Spec可用一致性的寫作風格及排版(標題符號、表述方式)，開發人員後續閱讀易懂性，增加Spec易讀性。EX：按鈕觸發的單元，每個按鈕接切分為檢核項目、DB異動、其他處理。