What is a Style Guide? - Speaker Deck

Slide 1

Slide 1 text

- 2012.11.10 / Yuya Saito - What is Style guide? υΩϡϝϯςʔγϣϯ ίʔσΟϯάͷ඼࣭Λอͭ ελΠϧΨΠυ ͷ࡞Γํ

Slide 2

Slide 2 text

L CSSRadar Yuya Saito

Slide 3

Slide 3 text

(Ex) Web Designer Front-END Developer I am @ CyberAgent

Slide 4

Slide 4 text

-Agenda- What is Style Guide? 1. Benefits of 2.Style Guide Creating Style Guide 3.

Slide 5

Slide 5 text

Slide 6

Slide 6 text

New Guys Come 2 Launch Site 1 Broken Site 3

Slide 7

Slide 7 text

YOU Are! ! New Guys ⚠

Slide 8

Slide 8 text

ελΠϧΨΠυ͸ ͦΜͳࠞཚΛ ܰݮ͢Δ υΩϡϝϯτ

Slide 9

Slide 9 text

What is Style Guide? 1.

Slide 10

Slide 10 text

Identity Guide

Slide 11

Slide 11 text

www.gov.uk/designprinciples

Slide 12

Slide 12 text

Comprehensive GuideLine

Slide 13

Slide 13 text

www.bbc.co.uk/gel/

Slide 14

Slide 14 text

Coding Standard

Slide 15

Slide 15 text

github.com/rwldrn/idiomatic.js

Slide 16

Slide 16 text

github.com/necolas/idiomatic-css

Slide 17

Slide 17 text

Style Guide? So What is ໨త͸ ڞ௨ݴޠΛ ੜΈग़͢͜ͱ u

Slide 18

Slide 18 text

ڞ௨ݴޠ ≊ ίϛϡχέʔγϣϯ

Slide 19

Slide 19 text

Documentation isBoring So Make it Fun!

Slide 20

Slide 20 text

Benefits of 2.Style Guide

Slide 21

Slide 21 text

αΠτશମͰ ར༻͍ͯ͠Δ શͯͷ ίϯϙʔωϯτ ΛϖʔδͰ දࣔ͢Δ υΩϡϝϯτ

Slide 22

Slide 22 text

DEVELOPING/DESIGN Documentation 8F

Slide 23

Slide 23 text

3 DEVELOPING/DESIGN Documentation 8F

Slide 24

Slide 24 text

Live & Automatic Live Automatic

Slide 25

Slide 25 text

No Documentation!? Wrong Documentation!?

Slide 26

Slide 26 text

Live & Automatic can solve them Say No More

Slide 27

Slide 27 text

kStyle Guide Makes CSS Testable

Slide 28

Slide 28 text

FFFFFFFFF FFFFFFFF X FStyle Guide is One Page Documentation

Slide 29

Slide 29 text

CSS CascadeS

Slide 30

Slide 30 text

rStyle Guide Helps develop with OOCSS

Slide 31

Slide 31 text

OOCSS?

Slide 32

Slide 32 text

github.com/stubbornella/oocss

Slide 33

Slide 33 text

smacss.com

Slide 34

Slide 34 text

blog.millermedeiros.com/solid-css/

Slide 35

Slide 35 text

OOCSS: ମܥཱͬͨ਺গͳ͍ $44։ൃ΁ͷΞϓϩʔν

Slide 36

Slide 36 text

X X X

Slide 37

Slide 37 text

Ͳ͏΍ͬͯϕʔεΦϒδΣΫτΛ ઃܭ͢Δͷ͔ʁ ?

Slide 38

Slide 38 text

Ernest Hemingway Said: The first draft of anything is shit. ղܾ ͱʹ͔͘࡞ͬͯ͠·͏

Slide 39

Slide 39 text

RefactorAble Make CSS

Slide 40

Slide 40 text

LStyle Guide Creates Shared Vocabulary

Slide 41

Slide 41 text

ίϛϡχέʔγϣϯͱ͸ ͓ޓ͍ͷڞ௨ೝࣝΛ ݶΓͳ͘ଟ͘࡞Δ͜ͱ υΩϡϝϯςʔγϣϯ͸ ͦͷڞ௨ೝࣝΛ ੜΈग़ͨ͢Ίͷπʔϧ

Slide 42

Slide 42 text

DStyle Guide Forces Writing Comments

Slide 43

Slide 43 text

Slide 44

Slide 44 text

ࣗಈͰ ͦͷίϝϯτ͔Β ελΠϧΨΠυ͸ )5.-Λੜ੒

Slide 45

Slide 45 text

Examples

Slide 46

Slide 46 text

github.com/styleguide

Slide 47

Slide 47 text

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

Slide 48

Slide 48 text

flic.kr/p/9v2Pgx

Slide 49

Slide 49 text

Not Just Examples Read the Code

Slide 50

Slide 50 text

Creating Style Guide 3.

Slide 51

Slide 51 text

BY Jacob Rask StyleDocco  github.com/jacobrask/styledocco

Slide 52

Slide 52 text

BY Kyle Neath KSS  github.com/kneath/kss

Slide 53

Slide 53 text

StyleDocco CUI

Slide 54

Slide 54 text

Install StyleDocco

Slide 55

Slide 55 text

sudo npm install -fg styledocco

Slide 56

Slide 56 text

styledocco <Φϓγϣϯ><ελΠϧγʔτσΟϨΫτϦ> Usage:

Slide 57

Slide 57 text

styledocco assets/style

Slide 58

Slide 58 text

http://d.pr/cV2N

Slide 59

Slide 59 text

No content

Slide 60

Slide 60 text

No content

Slide 61

Slide 61 text

github.com/studiomohawk/demo-styleguide

Slide 62

Slide 62 text

/* # ϒϩοΫ໊͜͜ʹϘλϯɺφϏήʔγϣϯͳͲελΠϧ͕ԿΛ͍ͯ͠Δ͔Λ ؆ܿʹઆ໌͍ͯͩ͘͠͞ɻ Ұߦۭ͚ͯɺͪ͜Β͸ϒϩοΫͷઆ໌จͰ͢ɻ ελΠϧཁૉͷ໾ׂ΍ৼΔ෣͍Λઆ໌͢Δ৔ॴͰ͢ɻ ͕͜͜࢓༷ॻʹ͋ͨΔ෦෼ʹͳΓ·͢ɻ ίϝϯτϒϩοΫ಺͸NBSLEPXOͱ͍͏ܗࣜͰهड़͠·͢ɻ ``` ྫࣔ͞ΕΔ)5.-͸͜ͷόοΫςΟοΫΛճ܁Γฦͨ͠ϒϩοΫ಺ʹ هड़͠·͢ɻ ٙࣅཁૉΛදࣔ͢Δ৔߹͸Ϋϥε໊ͱͯ͠AIPWFSAɺABDUJWFAͳͲίϩϯΛ ؚΊͯهड़͍ͯͩ͘͠͞ɻ ``` */

Slide 63

Slide 63 text

Slide 64

Slide 64 text

Slide 65

Slide 65 text

Slide 66

Slide 66 text

/* # Ϙλϯ Ϙλϯ͸ͳΔ΂͘େ͖͘ɺΫϦοΫͰ͖Δͱ෼͔ΔΑ͏ʹ͢Δ͜ͱ ABAɺACVUUPOAɺAJOQVUAɺ ·ͨ͸AJOQVUA͸ಉ͡ελΠϧʹ͢Δ͜ͱ AIPWFSAɺABDUJWFA GPSNλάܥʹ͸AIPWFSAɺABDUJWFAΫϥεΛ ෇༩͢Δ ʹ͸ඞͣঢ়ଶʹ߹ΘͤͨελΠϦϯάΛߦ͏͜ͱ AEJTBCMFEAɺ·ͨ͸AEJTBCMFEA΋ಉ༷ʹঢ়ଶʹ߹ΘͤͨελΠϧΛ ߦ͏͜ͱ ``` Ϙλϯ (a.btn.btn-fluid) ``` */

Slide 67

Slide 67 text

www.a-blogcms.jp

Slide 68

Slide 68 text

Tips and Tricks

Slide 69

Slide 69 text

Sass SCSS Less Stylus ΋ར༻Մೳ

Slide 70

Slide 70 text

Readme.md Index.html ͕͋Δ৔߹ʹ͸ Λੜ੒͢Δ

Slide 71

Slide 71 text

εϖʔεΛೖΕΔͱ ίϝϯτͷલʹ υΩϡϝϯτʹ ൓ө͠ͳ͍

Slide 72

Slide 72 text

:hover :focus දࣔͰ͖Δ ͳͲͷٙࣅΫϥε΋

Slide 73

Slide 73 text

styleGuide? What To

Slide 74

Slide 74 text

Not every CSS rule should be documented. You should document a rule declaration when the rule can accurately describe a visual UI element in the styleguide. Each element should have one documentation block describing that particular UI element's various states. - Kyle Neath

Slide 75

Slide 75 text

Buttons Navigations Forms Tabs Typography Etc.

Slide 76

Slide 76 text

ʹ͋ΔΑ͏ͳ6*ཁૉ͢΂ͯ Basically: Twitter Bootstrap Zurb Foundation

Slide 77

Slide 77 text

Conclusion...

Slide 78

Slide 78 text

࣮ࡍͷαΠτͱڞ௨ͷ $44ͷίϝϯτ͔Β ࣗಈͰυΩϡϝϯτΛੜ੒ Style Guide:

Slide 79

Slide 79 text

ߋ৽͞Εͳ͍υΩϡϝϯτΛࠜઈ͠ ΧεέʔυͷεύήοςΟΛςελϒϧͰ ݎ࿚ͳ؀ڥʹมԽͤ͞ ΦϒδΣΫτࢦ޲ͳ$44Λهड़͢Δ खॿ͚Λ͠ ΢ΣϒαΠτͷϧοΫϑΟʔϧΛ ౷Ұ͢Δ