Member-only story
Authoring Good Design Documentation
Good documentation is vital and shows that you care about your design system and those who will use it. Lacking good documentation practices could spell doom for a design system.
This is an excerpt from a course I have released on Newline, called “The newline Guide to React Component Design Systems with Figmagic”. You might also be interested in my other articles, such as “How To Automate Design Handoffs and Set Up a Design System with Figmagic”.
I’d like to present some ways in which we can meaningfully and painlessly document a design system and still make sure that Figma is our source of truth.
We do this also because we care about other people, and so that our design system — a complex entity in its own right — can be used at all in a productive manner.
The heart of this matter is that you should try to make it easy for people to do the right thing and what is expected of them.
Documentation is debt
All code is debt. As it happens, tech debt is not even actually about technology; it’s about people and the things we do. As I’ve already mentioned in a previous lesson, even our design doodles are future debt because they…
