Documentation Template

owl-listener/designer-skills/design-systems/skills/documentation-template

作者 owl-listener9a6930cf84a8无许可证2.8K 个星标收录于 2026年10月8日更新于 2026年10月8日仓库4周前更新

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`.

AI 生成的概览

为设计系统的组件、模式和基础规范生成可复用的文档模板。

功能
该技能产出文档脚手架,用于统一设计系统各类内容的撰写方式。它定义了组件文档、模式文档和基础文档三类模板,每类都有各自的章节大纲。它还列出标题层级一致、长页面目录、对比表格和成熟度状态标识等标准,以及维护方面的最佳实践。
适用场景
当你需要为设计系统或其组成部分建立一致的文档结构时使用。它适合希望统一组件、模式和基础规范描述方式的团队。若需要单个组件规格的具体内容,该技能会指向另一个 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

来源与署名

来源:owl-listener/designer-skills位于design-systems/skills/documentation-template提交9a6930c

许可证: 无许可证

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架