前言¶
在智能體開發與 DeepSeek Harness (DSH) 的使用場景中,設計文檔的輸出往往缺乏統一的格式規範。智能體可能生成鬆散的 Markdown,導致後續的解析、審查或自動化工具難以處理。爲了解決這個問題,我們需要一種機制,將設計文檔的結構化數據與解釋性文本結合起來,形成標準化的 DESIGN.md 格式。
插件定位¶
dsh-designmd 是 satan9394 維護的一個 DSH 技能。它定義了一套基於 DESIGN.md 的設計系統格式標準。該技能不直接生成設計內容,而是通過定義一套規範,確保輸出的文檔能夠被後續的 lint、diff 和 export 工具鏈正確處理。
核心能力¶
該插件定義了以下核心機制:
- YAML tokens:將設計中的關鍵屬性(如組件名、屬性值)定義爲結構化的 YAML tokens。
- Markdown rationale:在文檔中結合 Markdown 格式,說明設計背後的理由和上下文。
- Token 引用:在文檔中建立對定義好的 YAML tokens 的引用關係,形成數據與文本的關聯。
- Lint/Diff/Export 工具鏈:提供一套工具鏈,用於校驗文檔格式、對比差異以及導出標準格式。
- WCAG AA 對比度:集成無障礙訪問標準,檢查設計文檔中涉及的顏色或對比度是否符合 WCAG AA 級別。
安裝與啓用¶
當前暫無官方提供的安裝命令。
使用建議¶
- 適用場景:適用於需要建立嚴格設計文檔規範、或者希望將設計文檔自動化處理(如導出、審查)的開發團隊和智能體開發者。
- 權限與安全:插件以當前 DSH 進程的權限運行。在啓用前,請務必檢查其 GitHub 源碼,確認其行爲符合安全預期。
總結¶
dsh-designmd 爲 DSH 生態中的設計文檔輸出提供了一個標準化的解決方案。通過引入 YAML tokens 和配套的工具鏈,它幫助開發者從鬆散的 Markdown 中提取結構化信息,並確保文檔的可維護性與規範性。更多細節可查閱其 GitHub 倉庫。