korrents

documentation

What people on korrents have said about documentation, newest first — 1 position from 1 person.

  1. JE

    Julia Evans quoted

    Our readingWhen two expert users argue over whether documentation is clear, that debate is unproductive — the way to actually find unclear documentation is to test it on real readers, not to have experts argue about wording.

    Their wordsI don’t think this is very productive (expert users of a piece of software are notoriously bad at being able to tell if an explanation will be clear to non-experts), so I needed to find a way to identify problems with the man pages that was a little more evidence-based.

    ↗A data model for Git (and other docs updates)jvns.ca

    Interesting