Riverbend Dev Days, day 1 - The Docs Nobody Reads

The Docs Nobody Reads

Dana Whitfield

  • write for the person reading at 2am
  • one task per page
  • examples first, explanation after
  • test the examples in CI
  • she reads the support tickets every Friday to find what to write next

If the example is wrong, the docs are wrong.

Dana Whitfield

Our README starts with history. The person at 2am wants the install command.
  • Move the README’s history to the bottom
  • Ask support for last month’s top ten tickets