Giter VIP home page Giter VIP logo

talk---dont-write-documentation's Introduction

We can all agree the world is under-documented. However, some of the documentation that currently exists, shouldn't, and it trains users to ignore the other docs we've spent so much time crafting.

We'll talk about common documentation traps, including autogenerated text and poka-yoke replacements, and how to recognize and purge them in your own projects to create a better user experience.

Outline

  1. Introduction
    1. Me
    2. iFixit/Dozuki/tech writing program/HBR article
  2. About the title
    1. Good documentation's worst enemy is bad documentation
  3. "Documentation sucks"
    1. Bug in software, we might say "never use this software" (ImageMagick)
    2. Bug in documentation, we say "never use any documentation"
    3. In general, we're all numb to documentation - we don't read it because we expect it to be bad.
      1. Sometimes this bites us in the butt - my magnet-powered flashlight.
    4. Broken window syndrome. Bad docs beget bad docs.
  4. (Aside) Outdated docs
    1. How do we solve this? Pre-merge documentation update requirement
    2. Code + docs + tests + metrics + alerts
  5. Auto-generated docs
    1. Laziness, impatience, hubris.
    2. Laziness leads to computers writing documentation, which sucks.
    3. Humans read your docs, so humans need to write them.
  6. Overly-verbose instructions.
    1. Omit needless words.
    2. Know your audience - don't write super-introductory text for experienced users.
  7. Poka-yoke replacements.
    1. git-scripts feature/hotfix merge

talk---dont-write-documentation's People

Contributors

xiongchiamiov avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.