前言¶
在智能体开发与 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 仓库。