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 從公開儲存庫中收錄這些內容。

檢舉或申請下架