“How I Judge the Quality of Documentation in 30 Seconds”

, ,

A quick-ish post buy Eric Holscher, of Read the Docs. I agree with all of this, therefore I am linking to it. tl;dr: Have a website, not a directory of text files. Use prose, not auto-generated bullshit. Use permalinks. Have the language and version # in your URLs. Keep docs keyed to version #s.

Leave a Reply

Your email address will not be published. Required fields are marked *

This site uses Akismet to reduce spam. Learn how your comment data is processed.

Hello There

My name is Phil Nelson and I make beautiful things for a troubled world. I'm a designer / developer / writer / director / editor / narrator at Occipital.

Stuff I Make

More To See and Read

Browse the Archives

Hey. What're you doing all the way down here? You get lost? Just looking around? Cool. I like you.