A lightning talk focused on use case driven documentation.
Current deck from: React Day Berlin Recording: http://bit.ly/rdb-docs
Humanizing YourDocumentation@carolstran
View Slide
Why do we writedocumentation?
Use case drivendocumentation
bit.ly/tyner-blain
● How to adjust the speed● How to change the direction of the drill● How to change the drill bitbit.ly/tyner-blain
● How to drill a hole in a flat surface● How to select the right screw forfastening items● How to stir paint with your drillbit.ly/tyner-blain
GoalUse casebit.ly/tyner-blain
GoalUse caseFunctional RequirementDesignImplementationbit.ly/tyner-blain
LanguageGender neutralNo “simple” or “easy”No read timesBe literalUse plain language
AccessibilityWell-structured contentDescriptive linkingDon’t use color toconvey informationSpecific titlesWatch your font weight