Slashdot Mirror
RTFM = Read the Funny Manual?
coronaride writes: "This article over on Wired discusses the issue near and dear to every sysadmin and support tech's heart. I, myself, never read any manuals that accompany the products I buy (but when does cheese-whiz really need instructions anyways?) unless something majorly goes wrong! The article talks about how some countries, including Japan, try to spice up their product manuals in order to entice the users to read them. Is this just too much work for our lazy American manufacturers to do?"
Randal Schwartz's first O'Reilly Programming in Perl was also fun, for the humor placed in it, which keeps the student amused rather than dry, clinical and boring, which IMHO the 2nd edition was.
Some people view humor as a distraction in documents, perhaps so, if the humor gets in the way of getting the information across. I try to put some humor into sample data and documents, but usually it takes someone with special knowledge to notice (i.e. an address for J. T. Kirk, 1701 Enterprise Place) or silly things to fill in space in an example form, like creating combinations of funny words randomly to fill out the space in a new P.O. form. (BTW, programming in PCL sucks!)
It also seems to make the job of writing documentation a bit easier.
A feeling of having made the same mistake before: Deja Foobar
"We have noticed that if a manual said, 'Do not ever do this,' we would then get many calls from people who had broken their machines by doing just that," Esposito said. "They read the documentation and took offense to its tone so they had an argument with the product."
I found this to be an amusing story. However, the best way to deal with the whole manual issue is to design your product better. You know how you're not supposed to remove a game cartridge while you're playing? If you look at the SNES and the GameBoy, you are physically prevented from removing the cartridge because the power switch moves a piece that blocks the exit of the cartridge.
I realize this won't work in every situation, but the solution of 'we need to get people to read the manuals!' isn't going to go very far.
Getting back to the SNES example, I read the manual before playing the machine. Heck, I'm an expert on it! I used to sell them! Despite my detailed knowledge of how the machine works and the consequences of pulling the cartridge out while it's on, I'm still aware of the power switch blocking exit of the cartridge. Why? One day, a friend of mine came over with a new game I had been waiting for for ages. In a rush to pop this game in, I gave the cartridge in the machine a pretty good tug. Fortunately, it didn't give though. The safety feature of the SNES prevented me from making a 'wandering mind' mistake.
In cases like that, you could know the product inside out and still make bone-headed mistakes like that. Fortunately for me, Nintendo was smart enough to anticipate that I might make a mistake like that and design it so it's not easy to do.
"Derp de derp."
Mackie (sound reinforcement and processing) is another company who puts some humor in their manuals - the manual for their 1604VLZ mixer, for example is full of material that, while not being laugh-out-loud funny, is also not man-this-is-so-boring-I-want-to-die. The effect of this is that I have actually read the whole thing, cover to cover, and learned a whole lot more about the product than I would have if they had just gone with the standard technical writing standard.
If all the world's a stage, anyone who says they want better lighting spends far too much time in a dark theatre.
When I worked for Fifth Generation Systems (Fastback, Direct Access & Suitcase), the person in charge of producing manuals used to do this on purpose to "F" with management because they never read the manuals or even knew what the products really did. I guess this is why the company was sold to Symantec for a bargain basement price.
Strange women lying in ponds distributing swords is no basis for a system of government.
I have a Prime manual from the early 1980s that has a long running joke in it.
It is a manual for a version of "runoff", which is used for formatting documents. The examples given in the book are for a restraunt chain that servers "frog burgers". There are a whole bunch of Cthulhu references throughout.
I need to scan some of them and post them to the net. Pretty funny.
Another example is in the error return values in GLIBC. Included are EIEIO and EGREGIOUS and other bogus errors.
Unfortunatly all traces of humor are removed from manuals, not due to burn out or other causes, but because Corporate America sees them as "Not Profesional".
Funny documentation and Easter Eggs are both a causualty of the War on Fun.
"Trademarks are the heraldry of the new feudalism."
I skimmed the manual for a piece of internal software my company had created and found a note that basicly read, if you've gotten to this point fax in this form and we will send you a copy of Myst.
I read a while ago (no, I can't find a reference) that a bank sent out an update to the terms of service for their credit cards. Buried somewhere in the middle was a line telling you that all you had to do was call a number and they would credit your account $5. They wanted to see how many people actually read the change.
IIRC the response rate was under 1%. I try to tell myself[1] that they weren't doing this as a prelude to screwing their customers even harder.
[1] What I say when I don't want to think about something I have no control over that I am absolutely convinced is true.
Nope, no sig