Link
Embed
Share
Beginning
This slide
Copy link URL
Copy link URL
Copy iframe embed code
Copy iframe embed code
Copy javascript embed code
Copy javascript embed code
Share
Tweet
Share
Tweet
Slide 1
Slide 1 text
What I’ve learned building automated docs for ACE Ciro Nunes DesignOps wizard
Slide 2
Slide 2 text
@cironunesdev
Slide 3
Slide 3 text
Alex Leon The people involved Anthony Muscat Chantelle Staples
Slide 4
Slide 4 text
No content
Slide 5
Slide 5 text
Agenda 1. A bit of history 2. The journey towards automated docs 3. What we built so far 4. Takeaways and next steps
Slide 6
Slide 6 text
Ansarada Common Elements a.k.a ACE
Slide 7
Slide 7 text
39 Components and best practices
Slide 8
Slide 8 text
130 Design tokens
Slide 9
Slide 9 text
No content
Slide 10
Slide 10 text
No content
Slide 11
Slide 11 text
No content
Slide 12
Slide 12 text
No content
Slide 13
Slide 13 text
The process of creating and documenting components was completely manual, time consuming and error prone
Slide 14
Slide 14 text
No content
Slide 15
Slide 15 text
No content
Slide 16
Slide 16 text
Challenges
Slide 17
Slide 17 text
Challenges • Keep it up-to-date • Save time • Avoid errors • Make it fun
Slide 18
Slide 18 text
Challenges • Keep it up-to-date • Save time • Avoid errors • Make it fun Remedies
Slide 19
Slide 19 text
Challenges • Keep it up-to-date • Save time • Avoid errors • Make it fun Remedies • Automation ✓ Generate docs from code • Code snippets
Slide 20
Slide 20 text
We decided to rebuild our docs from scratch thinking in automation from day one
Slide 21
Slide 21 text
The journey towards an automatically documented design system
Slide 22
Slide 22 text
The Orbit project (automated docs)
Slide 23
Slide 23 text
The Orbit project (automated docs) 1 Survey & Research
Slide 24
Slide 24 text
The Orbit project (automated docs) 1 Survey & Research 2 Workshop
Slide 25
Slide 25 text
The Orbit project (automated docs) 1 Survey & Research 2 Workshop 3 Planning
Slide 26
Slide 26 text
The Orbit project (automated docs) 1 Survey & Research 2 Workshop 3 Planning 4 Execution (design & code)
Slide 27
Slide 27 text
The Orbit project (automated docs) 1 Survey & Research 2 Workshop 3 Planning 4 Execution (design & code) 5 Release MVP, gather feedback & Iterate
Slide 28
Slide 28 text
1 . Survey & Research
Slide 29
Slide 29 text
No content
Slide 30
Slide 30 text
No content
Slide 31
Slide 31 text
No content
Slide 32
Slide 32 text
No content
Slide 33
Slide 33 text
No content
Slide 34
Slide 34 text
No content
Slide 35
Slide 35 text
No content
Slide 36
Slide 36 text
No content
Slide 37
Slide 37 text
No content
Slide 38
Slide 38 text
No content
Slide 39
Slide 39 text
2 . Workshop
Slide 40
Slide 40 text
No content
Slide 41
Slide 41 text
3 . Planning
Slide 42
Slide 42 text
MVP
Slide 43
Slide 43 text
MVP 1. Generate docs from code
Slide 44
Slide 44 text
MVP 1. Generate docs from code 2. Use existing documentation
Slide 45
Slide 45 text
MVP 1. Generate docs from code 2. Use existing documentation 3. Improve the look and feel
Slide 46
Slide 46 text
No content
Slide 47
Slide 47 text
4. Design & code
Slide 48
Slide 48 text
No content
Slide 49
Slide 49 text
No content
Slide 50
Slide 50 text
No content
Slide 51
Slide 51 text
No content
Slide 52
Slide 52 text
5. Release & feedback
Slide 53
Slide 53 text
No content
Slide 54
Slide 54 text
No content
Slide 55
Slide 55 text
What we built so far
Slide 56
Slide 56 text
Demo time!
Slide 57
Slide 57 text
What I’ve learned
Slide 58
Slide 58 text
Design systems are more than just reusable components
Slide 59
Slide 59 text
Code comments are documentation
Slide 60
Slide 60 text
Types are documentation too !
Slide 61
Slide 61 text
Markdown is perfect to write documentation "
Slide 62
Slide 62 text
Takeaways & next steps
Slide 63
Slide 63 text
Takeaways
Slide 64
Slide 64 text
Takeaways 1. Reuse existing tools
Slide 65
Slide 65 text
Takeaways 1. Reuse existing tools 2. Design systems are more than just components
Slide 66
Slide 66 text
Ciro Nunes Writing docs is boring and keep them up-to- date is hard, time consuming and error prone. Don’t write it, generate it!
Slide 67
Slide 67 text
Next steps
Slide 68
Slide 68 text
Next steps 1. Include design tokens (Sass docs)
Slide 69
Slide 69 text
Next steps 1. Include design tokens (Sass docs) 2. Polish and implement new features
Slide 70
Slide 70 text
Next steps 1. Include design tokens (Sass docs) 2. Polish and implement new features 3. Make it a framework
Slide 71
Slide 71 text
Next steps 1. Include design tokens (Sass docs) 2. Polish and implement new features 3. Make it a framework 4. Open source it
Slide 72
Slide 72 text
No content
Slide 73
Slide 73 text
No content
Slide 74
Slide 74 text
No content
Slide 75
Slide 75 text
No content
Slide 76
Slide 76 text
@cironunesdev
Slide 77
Slide 77 text
What if I use Vue?
Slide 78
Slide 78 text
No content