Upgrade to Pro — share decks privately, control downloads, hide ads and more …

Documentation Driven Design Systems

9627abc56bc436faecbe45f2645159d6?s=47 Adekunle Oduye
December 04, 2017

Documentation Driven Design Systems

Let’s be real, most of us hate writing documentation. We procrastinate as if it will magically get done on its own, ultimately waiting until the very end of the design process to put something together. When we finally get down to it, the documentation winds up being unclear, confusing and simply not good. So the main question is: How do we make our documentation suck less?

9627abc56bc436faecbe45f2645159d6?s=128

Adekunle Oduye

December 04, 2017
Tweet

Transcript

  1. Documentation 
 Driven Design Systems FusionConf Dec 2017 @adekunleoduye

  2. L How do you say his name?

  3. L How do you say my name? Add-eh-koon-lay Oh-due-yay

  4. L Why do we write documentation?

  5. L Why do we write documentation? 1. Instructional 2. Educational

  6. None
  7. None
  8. Design System Team Breakdown Framework Creative Design System Docs

  9. Really, documentation?

  10. The struggles of writing documentation

  11. Documentation Pain Points • Writing documentation is hard • Documentation

    is last on the list • Documentation written for a specific audience
  12. Documentation Problems • No documentation • Poorly written documentation •

    Lack of consistency in documentation
  13. None
  14. None
  15. None
  16. Creating a documentation driven design system

  17. L Treat a design system like a product

  18. L Focusing on documentation first

  19. Anatomy of great documentation

  20. Documentation Outline • Overview • Implementation • Usages • Visual

    Details * • Dos & Don’ts *
  21. None
  22. None
  23. None
  24. None
  25. None
  26. The documentation process

  27. L Starting with an existing design system

  28. None
  29. None
  30. None
  31. None
  32. None
  33. None
  34. L Starting a new design system

  35. None
  36. What we learned • Communicate major updates to design systems

    • Validate patterns before release • Make it easier to integrate the style guide into products • More documentation on patterns
  37. Cross-functional design system team

  38. None
  39. None
  40. None
  41. None
  42. None
  43. None
  44. Socializing great documentation

  45. L Well written documentation can increase the usage of a

    design systems
  46. L Documentation should reflect the voice & tone of company

  47. L Create a standard for documentation and stick with it

  48. L Documentation that is digestible and easy to understand

  49. In Summary: • The anatomy of great documentation • The

    process of creating great documentation • How to socialize great documentation within your team and organization
  50. Thanks for listening! adekunleoduye.com @adekunleoduye