Skip to content

Example page meta data and terminology

Ben Brignell edited this page Jan 31, 2018 · 1 revision

Required

title

The title of the set of principles

Example:

title: The Five Principles of Design

author

The company, team or individual that created these principles.

Example:

author: Design Inc.

link

A link to a source article or somewhere the original principles were created.

Example:

link: http://example.com

principles

Each design principle on a new line under principles:

Example:

principles:
- principle: Accessible
- principle: Simple
- principle: Fast

Optional

overview

A brief introduction to give the example some context. Ideally the overview could cover questions such as, what kind of team was involved? What sort of challenges did they face? How did they choose their design principles? How did they measure their goals? What positive gains were there?

Example:

overview: Design Inc are a small design agency who have built a tool to help other designers prototype and validate their ideas. They spent 3 months choosing and refining their design principles by…

overview-author

If you've written an overview yourself you can add your twitter name as a credit.

Example:

overview-author: @benbrignell

summary

A brief summary of each design principle, what it means, how it's achieved…

Note: Please pay attention to how each line is indented, copy and edit the example below if necessary.

Example:

principles:
- principle: Accessible
  summary: |
    We strive to support any type of user regardless of ability or browser choice.
- principle: Simple
  summary: |
    Every element of the UI needs to add value and have a place.
- principle: Fast
  summary: |
    Performance is the biggest User Experience killer. Speed should take precedent over…

Clone this wiki locally