Writing Linux instructions for a Product Manual

Category: Linux

When I was given the task to write Linux instructions for a product being released by a major manufacturer, I was ecstatic. Having contributed to the online openSUSE wiki and Mandriva wiki a few times and a devoted Linux evangelist via this blog, I was raring to write about Yast2, Synaptic Package Manager, or even Yum.

Let's be honest: Windows users don't use product manuals and Mac users don't even know they exist. Linux users, on the other hand, either don't need any sort of printed instructions or consult community pages instead. If you've been using Linux for at least a year, chances are you're not too worried about making a basic consumer product like a Bluetooth dongle, external optical drive, or wireless card work.

Getting the chance to write Linux instructions for an official mainstream product manual felt like an enormous privilege. Most manufacturers ignore that Linux even exists although there are some companies like Samsung, Brother, and even Wacom that provide Linux pages on their support site.

I asked the product manager via chat for details regarding which Linux distribution should be featured on the chapter. He responded with:

"What is the most popular?"

I forced myself to shut up about preference, forks, desktop environments, Linux communities, and types of users. With gritted teeth, I answered:

"Ubuntu."

The product manager probably knew a little about Linux or he wouldn't have asked. And then I asked how many pages I could devote to the Linux section. Mac OSX Mountain Lion had 4 pages of screenshots and instructions to set up the procedure while Windows 7, Vista, and XP accumulated a total of 7 pages. I prayed fervently for slightly more than Mac OSX with visions of the command line, Ubuntu Software Center, and Synaptic package manager floating in my head. What he asked me was:

"Could you fit it in one page?"

If there was a Linux hell where penguins would routinely bite me, I deserved to be there. I wrote a four step procedure with two notes and three screenshots. I consoled myself that a real Linux user would never read an instruction manual and that there were tons of Ubuntu experts in the online community anyway.