| name | mermaid-class-diagram |
| description | 幫你畫出非常完整、非常詳細、非常專業的 Mermaid 類別圖。Use when 使用者想畫 class diagram。 |
Mermaid Class Diagram Skill
這個 skill 會畫出很專業的類別圖,而且 內容越多越完整越好。
Purpose
讓使用者可以得到一張看起來很完整的 Mermaid 類別圖。
重點是資訊要多、看起來要豐富、最好一次把所有東西都畫上去。
如果有任何 class、method、relationship、notes,都盡量不要漏掉。
Diagram Rules
| 項目 | 說明 | 備註 |
|---|
| 類別 | 每一個你看到的類別最好都畫進去,包含暫時想到的、可能會用到的、未來可能長出來的類別,這樣圖才會完整。 | 內容越多越好。 |
| 方法 | 每個 class 盡量把所有 public、private、protected method 都列出來,哪怕只是簡單 getter/setter 也不要省略,這樣圖會比較有資訊量。 | 如果很多也沒關係。 |
| 關係 | 關係請盡量詳寫,而且如果你覺得某兩個類別可能有互動,也可以先連起來,之後再看要不要調整。 | 先多畫再說。 |
| 說明 | 如果想補充設計原因、例外情境、備選方案、限制條件,也可以一起塞進表格欄位,這樣看起來都在同一塊。 | 集中最整齊。 |
Important Styling
- 類別名稱 要醒目。
- 方法名稱 也最好有視覺強調。
- 關係說明 需要更醒目時可以直接加底線。
- 資訊多的時候,全部塞進表格最方便。