The Evolution of Documentation in NASDAQ

Transcript

1. The evolution of documentation in NASDAQ Adekunle Oduye @adekunleoduye
2. My name is... • Product Designer at NASDAQ • Co-organizer at Gotham Sass & SassConf Adekunle Oduye (Add-eh-koon-lay Oh-due-yay)
3. What I hope everyone will learn: • How to write useful documentation • How docs can increase the usage of a design system
4. Where we started: Pattern Library
5. What was the purpose of the Pattern Library? • Was created for GCS design team • Used for creating front-end prototypes
6. How the Pattern Library was use Pattern Library Designer Designer Designer Designer Designer GCS Product Design Team
10. Problems with our Pattern Library • Misuse of patterns • Implementation wasn’t intuitive • Too many pattern variations
11. Where we ended up: UI Guidelines
12. How we wanted UI Guidelines to be used UI Guidelines GCS IRI GNW DOI NSS
13. UI Guidelines Team Breakdown UI Guidelines Framework Docs Creative
14. I wasn’t too excited about working on docs
15. Documentation Process
17. Documentation Process
18. Outline for creating documentation: • Overview • Implementation • Usages • Visual Details * • Dos & Don’ts * * These aren’t needed for all patterns
21. UI Guidelines: Buttons
22. UI Guidelines: Buttons
23. UI Guidelines: Buttons
24. UI Guidelines: Alerts
26. Using the same process for our charting library
32. “As instructions are to a product, documentation is to design systems”
33. A design system is an educational tool
34. In Summary: • Good docs contain details about implementation and usage • Have others within the company help when creating docs • Test out your documentation
35. Thanks for listening!!!! Adekunle Oduye @adekunleoduye www.adekunleoduye.com