Authoring Component Documentation

Model the Content, People, and Steps Involved

Nathan Curtis
Dec 19, 2018 · 4 min read
Image for post
Image for post

#1. Establish a Clear Yet Flexible Content Model


#2. Offer an Easy-to-Migrate Template To “Fill in the Blanks”


#3. Agree on Voice & Tone Through Iteration


#4. Expand a Visual Language for What Doc Needs


#5. Name One (or Two, or a Few) “System Editor(s)”


#6. Designers & Engineers Review Each Others Work. Always. Period.


#7. Integrate Reviews by Community Members


#8. Publish Incrementally, Since It’s Never Complete.

EightShapes

A collection of stories, studies, and deep thinking from…

Nathan Curtis

Written by

Founded UX firm @eightshapes, contributing to the design systems field through consulting and workshops. VT & @uchicago grad.

EightShapes

A collection of stories, studies, and deep thinking from EightShapes

Nathan Curtis

Written by

Founded UX firm @eightshapes, contributing to the design systems field through consulting and workshops. VT & @uchicago grad.

EightShapes

A collection of stories, studies, and deep thinking from EightShapes

Welcome to a place where words matter. On Medium, smart voices and original ideas take center stage - with no ads in sight. Watch

Follow all the topics you care about, and we’ll deliver the best stories for you to your homepage and inbox. Explore

Get unlimited access to the best stories on Medium — and support writers while you’re at it. Just $5/month. Upgrade

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store