返回提示词目录第 1416 页

设计系统文档站点规划

围绕设计与开发人员的查阅任务,规划文档站点结构、页面模板、搜索导航及版本维护和发布安排。

完整提示词

<context>
People arrive at design system docs with a task: which component do I use for this, how do I install it, what token is the border colour, can I do this with the button. Sites organised around the team's internal structure instead of those tasks go unread, and teams rebuild things that already exist. The other killer is drift: hand-written props tables and token lists go stale within weeks, so anything that can be generated from source (props, tokens, changelogs) should be. A component workshop such as Storybook is a good engineering tool and can be embedded, but on its own it does not serve designers or explain when to use what. Usage guidance comes first on every component page, platform differences need a clear home (tabs or separate pages), search needs synonyms because people look for "modal" when the system calls it "dialog", and every page needs an owner and a feedback path.
</context>

<task>
Plan the documentation site.

<system>
{{system}}
</system>
{{#problems}}

<problems>
{{problems}}
</problems>
{{/problems}}

1. **Audiences and tasks.** List the audiences (product designers, web engineers, native engineers, content designers, product managers, new joiners) and their top tasks, ranked.
2. **Information architecture.** A sitemap for the top two levels (for example Get started, Foundations, Components, Patterns, Content, Accessibility, Resources, What's new) with what goes where and why, driven by the tasks.
3. **Page templates.** Templates for a component page (status, usage first with when not to use, live examples, variants, accessibility, content guidance, props generated from code, design library link, related components, changelog), a foundation page, a pattern page and a getting-started page.
4. **Examples and code.** Live, editable examples where possible; which content is generated from source (props, tokens, changelog) and which is written by hand.
5. **Search and navigation.** Search with a synonyms list (seed it with likely pairs from the system), cross-links between design and code, and a "which component should I use" decision page.
6. **Versioning.** How docs track major versions, deprecated content and migration guides.
7. **Ownership and upkeep.** Who owns each section, docs updated in the same pull request as the component change, a review cadence, and a feedback link on every page.
8. **Tooling options.** Two or three ways to build the site that fit the stated tooling, with trade-offs; do not prescribe one product as the answer.
9. **Rollout.** What to publish first (top tasks and most used components), what can wait, and how to measure use (search queries with no results, page feedback).
</task>

<constraints>
- Do not invent the system's components, tokens or tooling; use what is given and mark proposals.
- Do not copy another organisation's documentation text; structure can be inspired, content must be original.
- Prefer generated content over hand-maintained copies wherever source exists.
{{> output/uncertainty}}
</constraints>

<output_format>
Markdown with the sections from the contract, in order. The sitemap as a nested list, page templates as heading outlines, ownership as a table. End with Open questions.
</output_format>

可替换内容

  • {{system}}
  • {{#problems}}
  • {{problems}}
  • {{/problems}}
  • {{> output/uncertainty}}

分类与标签

设计创意、设计系统、文档站点、信息架构、组件文档、版本维护

前往 AI 图片创作