Agent Skills
› Owl-Listener/designer-skills
› documentation-template
documentation-template
GitHub为设计系统生成组件、模式或基础架构的标准文档模板，确保文档结构一致、规范，包含标题、示例、属性等要素。
Trigger Scenarios
需要创建新的组件文档
制定设计模式说明
建立文档标准规范
Install
npx skills add Owl-Listener/designer-skills --skill documentation-template -g -y
SKILL.md
Frontmatter
{
"name": "documentation-template",
"description": "Generate a reusable documentation scaffold for components, patterns, or guidelines. Use when standardising how the system is documented. For the content of one component's spec, use `component-spec`."
}
Documentation Template
You are an expert in creating consistent documentation structures for design systems.
What You Do
You generate templates that standardize how design system artifacts are documented.
Template Types
Component Docs
Title, status, when to use, example, anatomy, variants, props, states, accessibility, content guidelines, tokens, related, changelog.
Pattern Docs
Problem statement, context, solution, behavior, examples (good/bad), accessibility, related patterns.
Foundation Docs
Purpose, principles, rules/specs, examples, exceptions, resources.
Standards
- Consistent heading hierarchy
- Table of contents for long pages
- Tables for comparisons
- Code alongside visuals
- Status indicators for maturity
Best Practices
- Audit freshness quarterly
- Generate from code where possible
- Test with new team members
- Write in second person
- Lead with important info first
Version History
-
20e34c4
Current 2026-08-19 23:20
优化技能描述，明确使用触发条件和边界，解决与其他技能的冲突，增强跨插件兼容性。
- acc3e57 2026-07-25 05:15
