Humanizing Your Documentation - Lighting Talk

A lightning talk focused on use case driven documentation.

Current deck from: React Day Berlin
Recording: http://bit.ly/rdb-docs

Transcript

1. Humanizing Your
   Documentation
   @carolstran
   

   View Slide

2. Why do we write
   documentation?
   

   View Slide

3. Use case driven
   documentation
   

   View Slide

4. bit.ly/tyner-blain
   

   View Slide

5. ● How to adjust the speed
   ● How to change the direction of the drill
   ● How to change the drill bit
   bit.ly/tyner-blain
   

   View Slide

6. ● How to drill a hole in a flat surface
   ● How to select the right screw for
   fastening items
   ● How to stir paint with your drill
   bit.ly/tyner-blain
   

   View Slide

7. View Slide

8. Goal
   Use case
   bit.ly/tyner-blain
   

   View Slide

9. Goal
   Use case
   Functional Requirement
   Design
   Implementation
   bit.ly/tyner-blain
   

   View Slide

10. Goal
    Use case
    Functional Requirement
    Design
    Implementation
    bit.ly/tyner-blain
    

    View Slide

11. Goal
    Use case
    Functional Requirement
    Design
    Implementation
    bit.ly/tyner-blain
    

    View Slide

12. View Slide

13. Language
    Gender neutral
    No “simple” or “easy”
    No read times
    Be literal
    Use plain language
    

    View Slide

14. Accessibility
    Well-structured content
    Descriptive linking
    Don’t use color to
    convey information
    Specific titles
    Watch your font weight
    

    View Slide