Wednesday, November 15, 2006

Review of Our Product User Guide

Ah, so part of R&D's responsibilities is to make sure that the guy who writes the user manual does not screw up royally with the manual. This guy/girl is usually part of the marketing kind of organization. Supposedly, they do not need to be engineers, and do not need to have good technical skills. Fair enough, some R&D engineers in my department don't even have *any* technical skills in my opinion. But the least we can expect is that they have a good command of English and have proper understanding of how documents should be written. Right?

So here's the email from the guy who wrote the user guide (UserGuideGuy (UGG)).




Hi All,

I attached the draft version of the [product] User’s Guide. It’s the revised user’s guide with the additional eight features.

Please take note that we added in the new [feature] chapter. The additional features are written in RED (mostly done in Chapter 2 and 3).

Appreciate if you could review the document and provide any kind of feedback by 12.00pm this Friday (17 Nov).

I would consider you agree with the content if I do not receive any reply by then.

Thanks.

Rgds,
UGG



Ok, so far so good. Minor mistakes in the email, but a different expectation should be placed on the guide.

So, I flipped open the guide, and went straight for the RED section which supposedly he changed. Lo and behold! I saw this picture:



OMFG, even a 5 year old can see that this picture is majorly f*cked. He has the nerve to send that document to us for review!

I got agitated and decided to read the rest of the manual. No easy task as it is over 170 pages. I'm not done yet, but I've also sent an email to UGG to ask him if he has properly checked the non-RED section. I've found tons of mistakes in the non-RED sections too, and I plan to entrap him.

No comments: