Top Banner
Documenting an A T O M I C Design System with Jekyll Presented by @toddmoy from @viget
16

Documenting an Atomic Design System with Jekyll

Apr 15, 2017

Download

Design

Todd Moy
Welcome message from author
This document is posted to help you gain knowledge. Please leave a comment to let me know what you think about it! Share it to your friends and learn new things together.
Transcript
Page 1: Documenting an Atomic Design System with Jekyll

Documenting an

A T O M I CDesign System with Jekyll

Presented by @toddmoy from @viget

Page 2: Documenting an Atomic Design System with Jekyll

BACKGROUND

handoff to their tech team

3

Page 3: Documenting an Atomic Design System with Jekyll

AT0MIC DESIGN

ATOMS MOLECULES ORGANISMS TEMPLATES PAGES

4

Page 4: Documenting an Atomic Design System with Jekyll

DOCUMENTATION ISSUES

DesignSystem_20150120.pdfDesignSystem_20141218.pdfDesignSystem_20141205.pdfDesignSystem_20141120.pdfDesignSystem_20141101.pdfDesignSystem_20141031.pdfDesignSystem_20151010.pdf

FORMAT NAVIGATION & USABILITY VERSIONING

6

Page 5: Documenting an Atomic Design System with Jekyll

JEKYLL

8

A Static Site Generator

Page 6: Documenting an Atomic Design System with Jekyll

JEKYLLMARKDOWN

CONTENTstatic

web pages

# Title

Integer posuere erat a ante venenatis dapibus posuere velit aliquet.* Lorem ipsum* Dolor site amet…

HTML + CSS TEMPLATES

<%= partial(‘header’) %>

<body> <%= yield =>

</body>

<%= partial(‘footer’) %>

9

Page 7: Documenting an Atomic Design System with Jekyll

BUILT

JEKYLLWITH

22

Page 8: Documenting an Atomic Design System with Jekyll

How we used it

PROCESS

OMNIGRAFFLEINVISION

basecampJEKYLL

11

Page 9: Documenting an Atomic Design System with Jekyll

How we used it

STRUCTURE

12

Page 10: Documenting an Atomic Design System with Jekyll

How we used it

EDIT ING

13

Page 11: Documenting an Atomic Design System with Jekyll

How we used it

Purpose & UsAGE

SAMPLE SCREENS

FUNCTIONAL REQUIREMENTS

EDITORIAL Requirements

STYLISTIC GUIDELINES

INCLUDED COMPONENTS &

ELEMENTS

CONTENT

15

Page 12: Documenting an Atomic Design System with Jekyll

How we used it

COMMITS

16

Page 13: Documenting an Atomic Design System with Jekyll

How we used it

PULL REQUESTS

17

Page 14: Documenting an Atomic Design System with Jekyll

How we used it

HOSTING

18

Page 15: Documenting an Atomic Design System with Jekyll

FUTURE PLANS?

19

Page 16: Documenting an Atomic Design System with Jekyll

Thanks y’all!Presented by @toddmoy from @viget

21