ops-wiki-agent-kit 0.1.2 → 0.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -184,6 +184,7 @@ Mermaid 圖表與 ASCII Art 在部分 AI 工具、純文字閱讀器或文件平
|
|
|
184
184
|
| 維運導向 | 圖表文字說明應描述 trigger order、main responsibility、data movement、branch result、side effect、observable signal 或 troubleshooting clue。 |
|
|
185
185
|
| 覆蓋完整 | `flowchart`、`sequenceDiagram`、ASCII flow 或資料流向圖的文字說明應依圖表內容完整展開，覆蓋主要 node、step、edge、branch、handoff、input/output、status change、side effect 與可追查線索。 |
|
|
186
186
|
| 節點對照 | 若圖表包含多個處理節點、`alt` / branch / loop、DB / file / external system 或跨系統 handoff，圖下說明優先使用表格或分段清單，讓每個圖中節點與分支都能對應到文字。 |
|
|
187
|
+
| Mermaid label 語法安全 | Mermaid node label、edge label、message label 與 state label 不要直接使用 raw `;`；若需要描述多個動作、optional side effect 或 SQL 條件，優先拆成多個 node / edge / `opt` / `alt`，或移到圖表文字說明 / step table / SQL table。 |
|
|
187
188
|
|
|
188
189
|
### 圖表文字說明完成標準
|
|
189
190
|
|
|
@@ -287,6 +288,7 @@ Mermaid 圖表與 ASCII Art 在部分 AI 工具、純文字閱讀器或文件平
|
|
|
287
288
|
| ---------------- | -------------- | -------------- | ----------------------------------------------- |
|
|
288
289
|
| 失敗訊息（實線） | `A-xB: Error` | `A--xB: Error` | 使用 `-x` 表示實線帶叉號。 |
|
|
289
290
|
| 失敗訊息（虛線） | `A--xB: Error` | - | 虛線帶叉號語法在部分版本不支援，建議改用 `-x`。 |
|
|
291
|
+
| Message label 分隔 | `Processor->>DataStore: write primary record and optionally update status` | `Processor->>DataStore: write primary record; optional update status` | `sequenceDiagram` message label 不要直接使用 raw `;`；Mermaid 可能將 `;` 視為 statement separator，導致後半段被解析成新的無效語句。若要表達 optional side effect，優先拆成 `opt` block 或移到圖表文字說明 / step table。 |
|
|
290
292
|
|
|
291
293
|
### sequenceDiagram 範例
|
|
292
294
|
|