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

What I've learned building automated docs for A...

Ciro Nunes
January 14, 2019

What I've learned building automated docs for Ansarada's design system

Ciro Nunes

January 14, 2019
Tweet

More Decks by Ciro Nunes

Other Decks in Technology

Transcript

  1. Agenda 1. A bit of history 2. The journey towards

    automated docs 3. What we built so far 4. Takeaways and next steps
  2. Challenges • Keep it up-to-date • Save time • Avoid

    errors • Make it fun Remedies • Automation ✓ Generate docs from code • Code snippets
  3. The Orbit project (automated docs) 1 Survey & Research 2

    Workshop 3 Planning 4 Execution (design & code)
  4. The Orbit project (automated docs) 1 Survey & Research 2

    Workshop 3 Planning 4 Execution (design & code) 5 Release MVP, gather feedback & Iterate
  5. MVP

  6. 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!
  7. Next steps 1. Include design tokens (Sass docs) 2. Polish

    and implement new features 3. Make it a framework
  8. Next steps 1. Include design tokens (Sass docs) 2. Polish

    and implement new features 3. Make it a framework 4. Open source it