Style Guide Best Practices

252

Click here to load reader

Transcript of Style Guide Best Practices

Page 1: Style Guide Best Practices

STYLE GUIDES@brad_frost

Page 2: Style Guide Best Practices
Page 3: Style Guide Best Practices

Great news, team. We got the green light to redesign the homepage.

Page 4: Style Guide Best Practices
Page 5: Style Guide Best Practices

That’s great news, boss!

Page 6: Style Guide Best Practices

Yeah, the current homepage is super ugly!

Page 7: Style Guide Best Practices

Yeah and don’t even ask about the code quality lol.

Page 8: Style Guide Best Practices

Exciting! It will be great to do things right this time.

Page 9: Style Guide Best Practices

Yeah we’re going to use BEM…

Page 10: Style Guide Best Practices

And the visuals will be clean and flat.

Page 11: Style Guide Best Practices

Yeah and we’re definitely looking into React.js

Page 12: Style Guide Best Practices

And maybe this will give us the chance to finally

migrate to a new CMS.

Page 13: Style Guide Best Practices

Grunt.

Page 14: Style Guide Best Practices

Make it so.

Page 15: Style Guide Best Practices

LATHER. RINSE. REPEAT.

Page 16: Style Guide Best Practices
Page 17: Style Guide Best Practices
Page 18: Style Guide Best Practices
Page 19: Style Guide Best Practices
Page 20: Style Guide Best Practices
Page 21: Style Guide Best Practices
Page 22: Style Guide Best Practices
Page 23: Style Guide Best Practices
Page 24: Style Guide Best Practices
Page 25: Style Guide Best Practices
Page 26: Style Guide Best Practices
Page 27: Style Guide Best Practices
Page 28: Style Guide Best Practices
Page 29: Style Guide Best Practices
Page 30: Style Guide Best Practices

global

Page 31: Style Guide Best Practices

north america

Page 32: Style Guide Best Practices

latin america

Page 33: Style Guide Best Practices

chile

Page 34: Style Guide Best Practices

europe

Page 35: Style Guide Best Practices

india

Page 36: Style Guide Best Practices

australia

Page 37: Style Guide Best Practices

china

Page 38: Style Guide Best Practices

hong kong

Page 39: Style Guide Best Practices

taiwan

Page 40: Style Guide Best Practices
Page 41: Style Guide Best Practices

huge jerk.

Page 42: Style Guide Best Practices
Page 43: Style Guide Best Practices
Page 44: Style Guide Best Practices
Page 45: Style Guide Best Practices
Page 46: Style Guide Best Practices
Page 47: Style Guide Best Practices
Page 48: Style Guide Best Practices
Page 49: Style Guide Best Practices

We don’t have time for cohesion and continuity!

Page 50: Style Guide Best Practices

We’re too busy DISRUPTING!

Page 51: Style Guide Best Practices

ONE BRAND

Page 52: Style Guide Best Practices

MOREDEVICESENVIRONMENTS

PEOPLELANGUAGES

CONTENT

BROWSERS

MEDIUMSCOUNTRIES

SCREENSIZES

FEATURESPRODUCTSSERVICESFUNCTIONALITY

CUSTOMERSFORMATS

USERS

FORMFACTORSCONTEXTS

Page 53: Style Guide Best Practices

STYLE GUIDES

Page 54: Style Guide Best Practices
Page 55: Style Guide Best Practices
Page 56: Style Guide Best Practices

http://cargocollective.com/mcalkins/Walmart-brand-book-design

Page 57: Style Guide Best Practices

brand.wvu.edu

Page 58: Style Guide Best Practices
Page 59: Style Guide Best Practices
Page 60: Style Guide Best Practices
Page 61: Style Guide Best Practices
Page 62: Style Guide Best Practices
Page 63: Style Guide Best Practices
Page 64: Style Guide Best Practices
Page 65: Style Guide Best Practices

BRAND STYLE GUIDES๏ Purpose: establish guidelines for using core brand assets ๏ Audience: the entire organization, vendors and anyone

making use of brand assets ๏ Can include: Logos, typography, color palette, file templates,

assets, downloads, etc

Page 66: Style Guide Best Practices
Page 67: Style Guide Best Practices

https://www.google.com/design/spec/material-design/

Page 68: Style Guide Best Practices
Page 69: Style Guide Best Practices
Page 70: Style Guide Best Practices
Page 71: Style Guide Best Practices

DESIGN LANGUAGE GUIDELINES๏ Purpose: establish a design language for cohesive user

experience across a suite of products and services ๏ Audience: anyone creating user experiences for the

organization, mostly designers ๏ Can include: design principles, brand overlap, aesthetics, ux

principles, motion, etc

Page 72: Style Guide Best Practices
Page 73: Style Guide Best Practices

voiceandtone.com

Page 74: Style Guide Best Practices
Page 75: Style Guide Best Practices
Page 76: Style Guide Best Practices
Page 77: Style Guide Best Practices

VOICE AND TONE GUIDELINES๏ Purpose: establish and encourage a cohesive, appropriate

tone across the entire user experience ๏ Audience: content creators and editors, anyone writing copy

for the brand ๏ Can include: interface copy, marketing, documentation, blog

posts, legal, alerts, etc

Page 78: Style Guide Best Practices
Page 79: Style Guide Best Practices

http://www.economist.com/styleguide/

Page 80: Style Guide Best Practices
Page 81: Style Guide Best Practices
Page 82: Style Guide Best Practices
Page 83: Style Guide Best Practices

http://www.dal.ca/webteam/web_style_guide/writing_for_the_web.html

Page 84: Style Guide Best Practices

WRITING STYLE GUIDES๏ Purpose: establish and encourage a cohesive writing style

across all properties ๏ Audience: content creators and editors, anyone writing copy

for the brand ๏ Can include: grammar, proper content structure, general

writing best practices

Page 85: Style Guide Best Practices
Page 86: Style Guide Best Practices
Page 87: Style Guide Best Practices

code block

.thisishowwedoit {

}

CSS SYNTAX GUIDELINES

Page 88: Style Guide Best Practices

code block

.this-is-how-we-do-it {

}

CSS SYNTAX GUIDELINES

Page 89: Style Guide Best Practices

code block

.thisIsHowWeDoIt {

}

CSS SYNTAX GUIDELINES

Page 90: Style Guide Best Practices

code block

.this__is__how__we__do—-it {

}

CSS SYNTAX GUIDELINES

Page 91: Style Guide Best Practices

code block

.- -...- - ..- - —— .. . ..—— — {

}

CSS SYNTAX GUIDELINES

Page 92: Style Guide Best Practices

https://github.com/styleguide

Page 93: Style Guide Best Practices

https://github.com/styleguide/javascript

Page 94: Style Guide Best Practices

https://github.com/styleguide/javascript

Page 95: Style Guide Best Practices

CODE STYLE GUIDES๏ Purpose: establish code standards for teams to write more

cohesive, efficient, and maintainable code ๏ Audience: front-end developers, back-end developers, 3rd

party developers, summer interns, developers developers developers

๏ Can include: development principles, HTML structure guidelines, CSS architecture, syntax, best practices, JS style and best practices, backend language syntax and best practices

Page 96: Style Guide Best Practices
Page 97: Style Guide Best Practices

http://walmartlabs.github.io/web-style-guide

Page 98: Style Guide Best Practices
Page 99: Style Guide Best Practices
Page 100: Style Guide Best Practices
Page 101: Style Guide Best Practices
Page 102: Style Guide Best Practices
Page 103: Style Guide Best Practices

PATTERN LIBRARIES๏ Purpose: establish and maintain an effective interface

design system to create consistent UIs, speed up production, and create a watering hole for the team

๏ Audience: anyone touching the project: designers, developers, project managers, product owners, etc

๏ Can include: global elements, typography, image types, lists, navigation, blocks, media, animations, literally anything you include in a UI

Page 104: Style Guide Best Practices
Page 105: Style Guide Best Practices
Page 106: Style Guide Best Practices

MAKING PATTERN LIBRARIES HAPPEN

Page 107: Style Guide Best Practices

$ELL IT.

Page 108: Style Guide Best Practices

BENEFITS OF PATTERN LIBRARIES๏ Promotes UI consistency and cohesion

Page 109: Style Guide Best Practices

Consistency is one of the most powerful usability principles: when things always behave the same, users don't have to worry about what will happen. Instead, they know what will happen based on earlier experience. -Jakob Nielson

http://www.nngroup.com/articles/top-10-mistakes-web-design/

Page 110: Style Guide Best Practices

BENEFITS OF PATTERN LIBRARIES๏ Promotes UI consistency and cohesion ๏ Faster production

Page 111: Style Guide Best Practices

We just copied and pasted a pattern, changed a few things, and in twenty minutes we had built a system that was responsive; it looked great on mobile and it was nice to look at. [The status page] was one of those pages that not a lot of people will see. We call them the dark corners. -Federico Holgado

http://styleguides.io/podcast/federico-holgado/

Page 112: Style Guide Best Practices

By having a pattern you could actually use that's already 95% of the way there, it brings up the quality of everything so those dark corners actually aren't so dark any more. -Federico Holgado

http://styleguides.io/podcast/federico-holgado/

Page 113: Style Guide Best Practices

BENEFITS OF PATTERN LIBRARIES๏ Promotes UI consistency and cohesion ๏ Faster production ๏ Better workflow

Page 114: Style Guide Best Practices

Mostly designers will come up with rough representations of where things might live without going into too much detail because there's no longer a need to do that work up front and we can just tweak it in the browser afterwards. -Ian Feather

http://styleguides.io/podcast/ian-feather/

Page 115: Style Guide Best Practices

BENEFITS OF PATTERN LIBRARIES๏ Promotes UI consistency and cohesion ๏ Faster production ๏ Better workflow ๏ Creates a shared vocabulary

Page 116: Style Guide Best Practices

It is the common ground that designers and developers are all seeking…and I find that a style guide is really effective at providing that common ground. -Lincoln Mongillo

http://styleguides.io/podcast/lincoln-mongillo/

Page 117: Style Guide Best Practices

BENEFITS OF PATTERN LIBRARIES๏ Promotes UI consistency and cohesion ๏ Faster production ๏ Better workflow ๏ Creates a shared vocabulary ๏ Easier to test

Page 118: Style Guide Best Practices

It makes what you change in production a lot more easy to manage over the long term; you're able to debug things more effectively. You're able to have a view into how your code base is looking across a site versus having various artifacts show up across hundreds of pages. -Lincoln Mongillo

http://styleguides.io/podcast/lincoln-mongillo/

Page 119: Style Guide Best Practices

BENEFITS OF PATTERN LIBRARIES๏ Promotes UI consistency and cohesion ๏ Faster production ๏ Better workflow ๏ Creates a shared vocabulary ๏ Easier to test ๏ Useful reference

Page 120: Style Guide Best Practices

BENEFITS OF PATTERN LIBRARIES๏ Promotes UI consistency and cohesion ๏ Faster production ๏ Better workflow ๏ Creates a shared vocabulary ๏ Easier to test ๏ Useful reference ๏ Future-friendly foundation

Page 121: Style Guide Best Practices

SHOW, DON’T TELL.

Page 122: Style Guide Best Practices

http://cssstats.com

Page 123: Style Guide Best Practices
Page 124: Style Guide Best Practices
Page 125: Style Guide Best Practices

http://bradfrostweb.com/blog/post/interface-inventory

Page 126: Style Guide Best Practices
Page 127: Style Guide Best Practices
Page 128: Style Guide Best Practices

ROUND UP THE TROOPS

1

Page 129: Style Guide Best Practices
Page 130: Style Guide Best Practices

PREPARE TO SCREENSHOT

2

Page 131: Style Guide Best Practices

http://bradfrost.com/blog/post/conducting-an-interface-inventory/

Page 132: Style Guide Best Practices

SCREENSHOT EXERCISE

3

Page 133: Style Guide Best Practices

INTERFACE INVENTORY CATEGORIES๏ Global ๏ Image types ๏ Icons ๏ Navigation ๏ Forms ๏ Buttons ๏ Interactive Components ๏ Media

๏ Headings ๏ Blocks ๏ Lists ๏ 3rd party stuff ๏ Advertising ๏ Messaging ๏ Animation ๏ Colors

Page 134: Style Guide Best Practices
Page 135: Style Guide Best Practices
Page 136: Style Guide Best Practices

PRESENT FINDINGS

4

Page 137: Style Guide Best Practices

http://www.pointswestav.com/wp-content/uploads/2011/04/Projector-meeting.jpg

Page 138: Style Guide Best Practices

REGROUP & NEXT STEPS

5

Page 139: Style Guide Best Practices

๏ Documents your interface design patterns ๏ Points out inconsistencies ๏ Helps get buy-in from organization ๏ Establishes scope of work ๏ Is the genesis of a shared vocabulary ๏ Lays the groundwork for a future pattern library

INTERFACE INVENTORY

Page 140: Style Guide Best Practices

AND IF THE BOSS STILL SAYS NO, DO IT ANYWAYS.

Page 141: Style Guide Best Practices

You just sneak it in. It's what I'm going to do to make the quality of the work better. And I don't have to say it. It starts in the sales process. You just build enough budget so that you can do it. You don't have a conversation about it, it's just par for the course. You don't have to ask permission. -Dan Mall

http://www.stuffandnonsense.co.uk/blog/about/unfinished-business-episode-105-seventeen-coats-of-bullshit

Page 142: Style Guide Best Practices

IN ORDER TO MAKE THE WHOLE, YOU NEED TO MAKE THE PARTS.

Page 143: Style Guide Best Practices

ATOMIC DESIGN

Page 144: Style Guide Best Practices
Page 145: Style Guide Best Practices
Page 146: Style Guide Best Practices
Page 147: Style Guide Best Practices
Page 148: Style Guide Best Practices

ENTER KEYWORD

SEARCH THE SITE

SEARCH

Page 149: Style Guide Best Practices

ENTER KEYWORD

SEARCH THE SITE

SEARCH

Page 150: Style Guide Best Practices
Page 151: Style Guide Best Practices
Page 152: Style Guide Best Practices
Page 153: Style Guide Best Practices
Page 154: Style Guide Best Practices
Page 155: Style Guide Best Practices
Page 156: Style Guide Best Practices
Page 157: Style Guide Best Practices
Page 158: Style Guide Best Practices
Page 159: Style Guide Best Practices
Page 160: Style Guide Best Practices
Page 161: Style Guide Best Practices
Page 162: Style Guide Best Practices
Page 163: Style Guide Best Practices

ABSTRACT CONCRETE

Page 164: Style Guide Best Practices

ABSTRACT CONCRETE

CREATORS CLIENTS

Page 165: Style Guide Best Practices

REFERENCE BUILD REVIEW

Page 166: Style Guide Best Practices

http://styleguides.io/tools.html

Page 167: Style Guide Best Practices
Page 168: Style Guide Best Practices

DAVE OLSEN@dmolsen

Page 169: Style Guide Best Practices

WHAT PATTERN LAB IS๏ A design system builder ๏ Your comprehensive interface design system ๏ A style guide starter kit ๏ A design toolkit (viewport resizer and other tools)

Page 170: Style Guide Best Practices
Page 171: Style Guide Best Practices
Page 172: Style Guide Best Practices
Page 173: Style Guide Best Practices
Page 174: Style Guide Best Practices

https://mustache.github.io/

Page 175: Style Guide Best Practices
Page 176: Style Guide Best Practices

MOLECULE GUTScode block

<div class="block block-post"> <a href="{{ url }}"> <div class="b-img"> {{> atoms-thumb }} </div> <h3 class="b-title">{{ headline }}</h3> <p class="b-excerpt">{{ excerpt }}</p> </a> </div>

Page 177: Style Guide Best Practices

BASIC INCLUDEcode block

{{> molecules-block-post }}

Page 178: Style Guide Best Practices
Page 179: Style Guide Best Practices
Page 180: Style Guide Best Practices

ORGANISM GUTScode block

<header role="banner"> {{> atoms-logo }} {{> molecules-primary-nav }} {{> molecules-search }} </header>

Page 181: Style Guide Best Practices

ORGANISM INCLUDEcode block

{{> organisms-header }}

Page 182: Style Guide Best Practices
Page 183: Style Guide Best Practices
Page 184: Style Guide Best Practices
Page 185: Style Guide Best Practices

TEMPLATE GUTScode block{{> organisms-header }}

<main role="main"> {{# hero }} {{> molecules-hero-video }} {{/ hero }} <section> {{# experience }} {{> organisms-story-feature }} {{/ experience }} </section> <section> {{# factoid-advertising }} {{> organisms-factoid }} {{/ factoid-advertising }}

Page 186: Style Guide Best Practices
Page 187: Style Guide Best Practices

CONTENT STRUCTURE ACTUAL CONTENT

Page 188: Style Guide Best Practices
Page 189: Style Guide Best Practices
Page 190: Style Guide Best Practices
Page 191: Style Guide Best Practices

PIPING IN REAL CONTENTcode block{

"title" : "Time Inc.", "bodyClass": "home", "hero" : { "headline": "Moving People" "img": { "src": "/images/hero_beyonce.jpg", "alt": "Beyonce" } }

Page 192: Style Guide Best Practices

patternlab.io

Page 193: Style Guide Best Practices
Page 194: Style Guide Best Practices
Page 195: Style Guide Best Practices
Page 196: Style Guide Best Practices
Page 197: Style Guide Best Practices
Page 198: Style Guide Best Practices
Page 199: Style Guide Best Practices
Page 200: Style Guide Best Practices
Page 201: Style Guide Best Practices
Page 202: Style Guide Best Practices
Page 203: Style Guide Best Practices
Page 204: Style Guide Best Practices
Page 205: Style Guide Best Practices
Page 206: Style Guide Best Practices
Page 207: Style Guide Best Practices
Page 208: Style Guide Best Practices

http://trentwalton.com/2011/07/14/content-choreography/

Page 209: Style Guide Best Practices
Page 210: Style Guide Best Practices

…OR DID THEY?

Page 211: Style Guide Best Practices
Page 212: Style Guide Best Practices

Putting a style guide off to the end or treating it as a separate thing is just asking for it to just sort of die on the vine or become outdated and obsolete. -Jina Bolton

styleguides.io/podcast/jina-bolton

Page 213: Style Guide Best Practices
Page 214: Style Guide Best Practices
Page 215: Style Guide Best Practices

MAKE IT MAINTAINABLE

Page 216: Style Guide Best Practices

YOU SEEK THE HOLY GRAIL.

Page 217: Style Guide Best Practices

http://rizzo.lonelyplanet.com/

Page 218: Style Guide Best Practices
Page 219: Style Guide Best Practices

MAKE IT CROSS-DISCIPLINARY

Page 220: Style Guide Best Practices
Page 221: Style Guide Best Practices
Page 222: Style Guide Best Practices
Page 223: Style Guide Best Practices

MAKE IT APPROACHABLE

Page 224: Style Guide Best Practices

http://www.yelp.com/styleguide

Page 225: Style Guide Best Practices

http://sfdc-styleguide.herokuapp.com

Page 226: Style Guide Best Practices

http://purple.herokuapp.com

Page 227: Style Guide Best Practices

MAKE IT VISIBLE

Page 228: Style Guide Best Practices

When you start to place these kinds of assets behind constraints, many teams either take an outrageously long time to get access, or they never get access. -Nathan Curtis

http://styleguides.io/podcast/nathan-curtis

Page 229: Style Guide Best Practices

http://www.starbucks.com/static/reference/styleguide/http://www.starbucks.com/static/reference/styleguide/

Page 230: Style Guide Best Practices

styleguides.io/examples.html

Page 231: Style Guide Best Practices
Page 232: Style Guide Best Practices

Companies are using their style guide as a testament to what their belief system is and also an indicator of the quality of their organization; they're essentially using it as a recruiting tool. -Nathan Curtis

http://styleguides.io/podcast/nathan-curtis/

Page 233: Style Guide Best Practices

When I saw Salesforce’s style guide I thought it was beautiful and it's why I wanted to join this team. -Jina Bolton

styleguides.io/podcast/jina-bolton

Page 234: Style Guide Best Practices

MAKE IT AGNOSTIC

Page 235: Style Guide Best Practices
Page 236: Style Guide Best Practices
Page 237: Style Guide Best Practices
Page 238: Style Guide Best Practices

WARNING: NAMING THINGS IS REALLY FREAKING HARD.

https://www.flickr.com/photos/131260238@N08/

Page 239: Style Guide Best Practices
Page 240: Style Guide Best Practices
Page 241: Style Guide Best Practices

MAKE IT CONTEXTUAL

Page 242: Style Guide Best Practices
Page 243: Style Guide Best Practices

MAKE IT LAST

Page 244: Style Guide Best Practices

http://www.google.com/design/spec/whats-new/whats-new.html

Page 245: Style Guide Best Practices
Page 246: Style Guide Best Practices

https://flic.kr/p/5YnE4z

Page 247: Style Guide Best Practices
Page 248: Style Guide Best Practices

styleguides.io

Page 249: Style Guide Best Practices

http://styleguides.io/podcast

Page 250: Style Guide Best Practices

atomicdesign.bradfrost.com

Page 251: Style Guide Best Practices

atomicdesign.bradfrost.com

ONLY

$10!!!

Page 252: Style Guide Best Practices

THANKS! @brad_frost