(this page was created automatically. In case of formatting issues, please visit the official Wiki Page)

Wiki Page - Template

This page will give a systematic guide on the structure and required content of pages in this Wiki. Furthermore, it will outline rules on the formatting of text and images.

Structure

Overview

The overview will give a short introduction using four to five bullet points.

• Defines the primary purpose of the component
• Highlights main types or variations (if available)
• Lists the most important features and capabilities
• Notes limitations or constraints

In addition to the bullet points, the overview includes a picture showing of the most important variations and possibilities for the component.

Specs

The Specs have sections with sub headers (h3) explaining every possibility to edit the component. Each section has at least one picture detailing the terms referenced during the section. The text may also include the relevant code for the element. The main sections include:

• Tokens: a table of all usable tokens and a short description of their effect
• Structure & Layout: measurements, spacing, adaptive layout variation
• Styling: color, custom measurements
• Actions & Variants: interaction, transitions, variants
• Testing: automated testing

Not every component needs every section. Conversely, a new section can be created if necessary. Each section can include subsections (using Headings (h4) for clarity) if plausible.

Guidelines

• Explains how the component should be used correctly in different contexts
• Provides rules and best practices for application
• Includes Do’s and Don’ts to prevent misuse
• Must feature visual examples with correct and incorrect usage clearly marked

Accessibility

(in development)

• Protocol of implemented accessibility measures
• Practices to improve accessibility

General Rules

1. Sentences should be short and use easy language.
2. Repetition of information should be avoided. A detailed description should exist only once and further mentions should be short and relevant to the situation.
3. A listing of information during a paragraph should use bullet points instead of text.
4. Information should always be accompanied by a picture visualizing the information.
5. An Image should be labeled if they give information that is not described in the text accompanying it.