Humanizing Your Documentation - Lighting Talk

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

8c5989329a85b590fecdb4f7a97cbe3a?s=128

Carolyn Stransky

December 02, 2017
Tweet

Transcript

  1. Humanizing Your Documentation @carolstran

  2. Why do we write documentation?

  3. Use case driven documentation

  4. bit.ly/tyner-blain

  5. • How to adjust the speed • How to change

    the direction of the drill • How to change the drill bit bit.ly/tyner-blain
  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
  7. None
  8. Goal Use case bit.ly/tyner-blain

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

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

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

  12. None
  13. Language Gender neutral No “simple” or “easy” No read times

    Be literal Use plain language
  14. Accessibility Well-structured content Descriptive linking Don’t use color to convey

    information Specific titles Watch your font weight