Upgrade to Pro — share decks privately, control downloads, hide ads and more …

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

Carolyn Stransky

December 02, 2017
Tweet

More Decks by Carolyn Stransky

Other Decks in Technology

Transcript

  1. Humanizing Your
    Documentation
    @carolstran

    View full-size slide

  2. Why do we write
    documentation?

    View full-size slide

  3. Use case driven
    documentation

    View full-size slide

  4. bit.ly/tyner-blain

    View full-size 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 full-size 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 full-size slide

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

    View full-size slide

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

    View full-size slide

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

    View full-size slide

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

    View full-size slide

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

    View full-size slide

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

    View full-size slide