CAPTCHA
Image CAPTCHA
Enter the characters shown in the image.
This question is for testing whether or not you are human.
  • Create new account
  • Reset your password

User account menu

Home
The Hyperlogos
Read Everything

Main navigation

  • Home
  • My Resumé
  • blog
  • Howtos
  • Pages
  • Contact
  • Search

Web-Only Documentation: A Stupid Idea

Breadcrumb

  • Home
  • User Blogs
  • User Blog
  • Web-Only Documentation: A Stupid Idea
By drink | Sat September 08, 2007

Today while trying to figure out how to use two graphics packages, I discovered that people without internet connections apparently don't deserve documentation. I am still ignorant of how to rotate shapes in both Inkscape and Xara LX (two programs that will never ever challenge any real vector graphics software) assuming it's even possible, because the documentation is provided as a web link.

This seems like a strange thing to say on a webpage, but I am not connected to the internet as I write this! This article is being written in a period of downtime in which I am editing web content on a local copy on my laptop which will replace the current contents of my site. And this, of course, is the problem. It makes every bit of sense to provide a link to the latest documentation on the web inside the documentation. But not including documentation with the program is a move for idiots. It says that you do not care enough about the user experience to include any documentation. And it also says to the world that the developers don't know how the program works - they're just out there writing code.

Some programs don't particularly need much documentation; that's great. They have user interfaces that are laid out logically and which don't really require any advanced information to fathom. These programs don't really need any documentation, although it is always a mistake not to have any. Regardless, documentation should always come with the program. It's not unreasonable for the documentation to be a separate package, especially in the case of Unix systems with integrated package management. But it simply makes no sense for there not to be any local documentation.

The truly sad part is that if you are using any halfway decent system for your online documentation, you can export it to another format or even a subset of its own HTML for use offline. This does not happen for one or both of two reasons:

  • The people packaging the program are doing the work for their own glory, and don't actually care if you can use the software.
  • The people maintaining the online documentation are idiots who can't figure out how export the documentation.

Please, fight against software stupidity. Write and include documentation with your program. If you don't know what the program is supposed to do in a given instance, how do you even know it's working correctly?

web
software
rant
documentation
  • Log in or register to post comments

Footer menu

  • Contact
Powered by Drupal

Copyright © 2025 Martin Espinoza - All rights reserved