Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Speaker Deck
PRO
Sign in
Sign up
for free
The Evolution of Documentation in NASDAQ
Adekunle Oduye
May 14, 2017
Design
0
110
The Evolution of Documentation in NASDAQ
Adekunle Oduye
May 14, 2017
Tweet
Share
More Decks by Adekunle Oduye
See All by Adekunle Oduye
adekunleoduye
3
91
adekunleoduye
0
110
adekunleoduye
0
280
adekunleoduye
0
94
adekunleoduye
2
1.2k
Other Decks in Design
See All in Design
alvieave
0
180
masaki_narizuka
2
900
oakleybillions
1
330
andreh
0
120
nobtak
0
350
danpark001
1
3k
sincerelykain
0
110
tiagilles
0
210
ohtristanart
0
130
harutosuzuki
0
1.3k
tiagilles
0
210
isabellaspadone
0
220
Featured
See All Featured
dougneiner
119
7.8k
aarron
258
36k
frogandcode
127
20k
ammeep
656
54k
pedronauck
652
110k
rocio
155
11k
kneath
294
39k
sugarenia
233
840k
bryan
100
11k
destraynor
146
19k
shpigford
368
42k
swwweet
206
6.8k
Transcript
The evolution of documentation in NASDAQ Adekunle Oduye @adekunleoduye
My name is... • Product Designer at NASDAQ • Co-organizer
at Gotham Sass & SassConf Adekunle Oduye (Add-eh-koon-lay Oh-due-yay)
What I hope everyone will learn: • How to write
useful documentation • How docs can increase the usage of a design system
Where we started: Pattern Library
What was the purpose of the Pattern Library? • Was
created for GCS design team • Used for creating front-end prototypes
How the Pattern Library was use Pattern Library Designer Designer
Designer Designer Designer GCS Product Design Team
None
None
None
Problems with our Pattern Library • Misuse of patterns •
Implementation wasn’t intuitive • Too many pattern variations
Where we ended up: UI Guidelines
How we wanted UI Guidelines to be used UI Guidelines
GCS IRI GNW DOI NSS
UI Guidelines Team Breakdown UI Guidelines Framework Docs Creative
I wasn’t too excited about working on docs
Documentation Process
None
Documentation Process
Outline for creating documentation: • Overview • Implementation • Usages
• Visual Details * • Dos & Don’ts * * These aren’t needed for all patterns
None
None
UI Guidelines: Buttons
UI Guidelines: Buttons
UI Guidelines: Buttons
UI Guidelines: Alerts
None
Using the same process for our charting library
None
None
None
None
None
“As instructions are to a product, documentation is to design
systems”
A design system is an educational tool
In Summary: • Good docs contain details about implementation and
usage • Have others within the company help when creating docs • Test out your documentation
Thanks for listening!!!! Adekunle Oduye @adekunleoduye www.adekunleoduye.com