The evolution ofdocumentation in NASDAQAdekunle Oduye@adekunleoduye
View Slide
My name is...● Product Designer at NASDAQ● Co-organizer at Gotham Sass & SassConfAdekunle 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 usePatternLibraryDesigner DesignerDesignerDesignerDesignerGCS Product Design Team
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 usedUIGuidelinesGCSIRIGNWDOINSS
UI Guidelines Team BreakdownUI GuidelinesFramework DocsCreative
I wasn’t too excited about working on docs
Documentation Process
Outline for creating documentation:● Overview● Implementation● Usages● Visual Details *● Dos & Don’ts ** These aren’t needed for all patterns
UI Guidelines: Buttons
UI Guidelines: Alerts
Using the same processfor our charting library
“As instructions are to aproduct, documentation is todesign systems”
A design system is aneducational 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@adekunleoduyewww.adekunleoduye.com