Tuesday, 11 December 2007

How installation instructions for linux apps should look

or: Stop telling people to use the terminal unnecessarily!

I've lost count of the number of times I read something along the lines of:
Open the terminal and type "sudo apt-get install <package>"
Seriously. How hard is it to say "Run Synaptic Package Manager (From the administration menu)"?

I'll just list a few issues with the first method:
  1. If you can open a terminal, you can open Synaptic.
  2. apt-get throws up a lot of text even doing the simplest of installs.
  3. apt-get can be confusing if someone else tells a user to use "apt" or "aptitude" instead.
  4. Users who don't know how to install something that is one package are probably going to be happier with a GUI method.
  5. Synaptic informs the user clearly about dependencies and unverified sources, rather than as a stream of text.
  6. It is not good practice to get users used to blindly opening terminals and executing commands they don't understand. That is the path to sudo rm -rf woes.
  7. If you never discover Synaptic, you'll miss out on a lot of packages.
  8. If the name of a package has changed slightly, it's easier to find the correct package in Synaptic rather than guessing at names at the command line.
  9. Synaptic offers descriptions of packages, so the user may have at least some small grasp of what they're doing, rather than feeling like they're typing incomprehensible incantations that could do anything.
  10. Scanning through Synaptic is a great way to find new things.
  11. Uninstalling via Synaptic is far less confusing.
  12. Quitting Synaptic leaves no superuser windows lying around for misuse.
I'll stop at twelve. It's a nice number.

So remember: "First, open Synaptic. Next, find the package <blah> and install it (using the install button)"

No comments: