跳到內容
開始使用

用詞

這本手冊盡量用平常的話來寫,但有些詞會一直出現。這裡用一兩句話說明它們的意思。手冊、修改申請和 Claude 的回覆都用同一套詞,才不會誤會;這套用詞的正式版本在 repository 的 docs/rules/02-design-rules.md 第 1 節。

慈濟所有網站共用的一整套設計規則和現成元件,也就是這本手冊在講的東西。所有網站共用一套,不會一個網站一套。

一個有名字的設計數值,例如「品牌主色」color.brand.primary。大家都用名字來指它,要改顏色時只改一個地方,所有用到它的地方都會跟著變。改名保護(先棄用、再移除,由機器檢查)完成之前,所有 token 的名稱都不改,也不刪除。

所有網站共用的基本色階和數值刻度,例如一整排的藍色、間距和圓角的刻度(程式裡叫 primitive)。基礎只新增、不修改既有的值;主題也不改基礎。見色彩和字體。

依「用途」命名的顏色,例如「主色」「文字」「背景」「錯誤提示」(程式裡叫 semantic)。語意色指向某個基礎色;換主題或色彩模式時,主要是換語意色指向哪一個基礎色。

只給某一個元件用的設計數值,例如「按鈕的圓角」。它通常指向一個語意色或基礎數值,需要的時候可以只調整這個元件。

一組有名字的外觀設定,例如 Default、Green Natural。一個網站選用一個主題,沒有指定時用 Default。「主題」這個詞只用來指這種有名字的外觀。主題只寫和預設主題(Default)不同的外觀數值:先換語意色,只有某個元件仍然要不同時,才換那個元件的元件 token。今天只有 Default 是正式的,其他主題(Green Natural)都還是示意。見主題。

淺色或深色。色彩模式不是主題,不叫「主題」「深色主題」或「暗色」:主題是「哪一組有名字的外觀」,色彩模式是「淺色還是深色」,兩者可以自由搭配,每個主題都有淺色和深色。見色彩模式。

同一個元件的幾種設計或選項,例如按鈕有實心、外框、淡底三種(程式裡叫 variant)。我們新增的變體依用途命名(叫「精選」,不叫「大紅框」);名稱一旦被用了就不改、不刪除。內容一樣、只是排列不同時,用變體解決,再由每個網站設定自己的預設變體(網站設定檔還沒有實作)。

第一級、第二級、第三級

章節連結:第一級、第二級、第三級

一個網站想和其他網站不一樣時的判斷順序,用最低的那一級解決:

  • 第一級:只有外觀的數值不同(顏色、圓角、陰影、邊框、字級、間距)→ 主題。
  • 第二級:內容一樣,結構或排列不同 → 共用元件的變體。
  • 第三級:別的網站沒有的資料或功能 → 新元件。

都不是網站之間的差異時(例如所有網站一起改),寫「不適用」。見如何參與修改。

元件整個重新設計、而且新舊不能直接互換時,才出新版本。版本只用整數,例如 v1、v2,沒有 v1.2.3 這種號碼;小幅調整不會出新版本。出了 v2 之後,v1 仍然可以用,網站不必同時升級(這是提案,還沒有定案)。

用元件組好的整頁版面,例如入口首頁、文章列表。做新網頁時照著排,再換上自己的內容。見範本。

把修改交給負責的角色看的申請,工程師叫它 PR(pull request)。負責的角色看過後核可,再由有合併權限的人合併。見如何參與修改。

負責那一塊的角色看過修改申請,同意它可以合併。核可不等於合併。

手冊和 repository 裡的人員只寫職稱:美編(設計)、工程、專案負責人,不寫姓名。手冊裡唯一的例外是致遠(廠商):用這家廠商的公司名稱稱呼它,這是專案負責人的決定;手冊以外的檔案仍然寫「廠商」。

給工程師逐一檢查元件各種狀態的工具網站,和手冊是兩個分開的網站。見開始使用。