How I Judge the Quality of Documentation

Re:How I Judge the Quality of Documentation by adammil on Thursday February 27, 2014 @12:22PM (#7313433)

I'm with the author until he says to encode extra information into the URL. If the docs and the site are built well, you should find everything you need while completely ignoring the URL structure.

[ Parent | on HN ]

Re:How I Judge the Quality of Documentation by antsar on Thursday February 27, 2014 @12:39PM (#7313546)

Perhaps, but a well-designed URL structure is helpful when one sees a deep link to the site and wants to know what they'll find.

  example.com/how-to-bar-the-foo-v1

  docs.example.com/en/1.0/foo#bar

The latter form clearly presents the possibility of jumping straight to a different version's foo docs, to the docs homepage, etc. I'd consider this a quality of good UX.

[ Parent | on HN ]