burkphoto wrote:
Most manuals aren't great, because of budgetary constraints.
Good manual writers:
Illustrate
Number the parts
Cross reference everything
Get a native speaker to translate where necessary
Explain WHY a particular feature is of some benefit, and in what sorts of circumstances it is so
Write in complete sentences
Use terminology consistent with industry norms
One of the most important things I learned about communications, early in my career, is that "communications" means "common thoughts, held in union." As such, both parties are 100% responsible for their parts in the deal. It takes effort to transmit information. It takes effort to receive and process information.
Each of us comes to the table with a set of knowledge that is based on our own experiences and assumptions. If I'm not aware that you don't have a certain basic knowledge base required to understand what I'm saying, it's important for you to let me (or my company) know that, by asking questions, so I can make revisions. But it is also important for you to seek that knowledge elsewhere.
One of the survival instincts of any good student is persistent inquisitiveness. If you want to learn how to do something, you DIG for information about it, tirelessly. You seek everything you can find about it, and learn from that. You apply that knowledge and practice it in a "safe" environment. Then you evaluate how you are doing.
You don't just pick up an automatic camera and become a photographer. You might pick up your iPhone and think you are one, but either way, there is still an ocean of information out there that can help you refine your work.
Most manuals aren't great, because of budgetary co... (
show quote)
Few members of UHH know what really boring tech manuals are. While in USAF pilot training I had the chance to look through a copy of the B-52 flight manual. Section three (3) of each aircraft manual deals with emergency procedures. The edges of each page are "barber poled" as a reminder of the seriousness involved. Section 3 of the B-52 manual has a procedure for "Landing with 4 (four) engines inoperative on one wing." Life doesn't get any tougher than a pilot trying to learn how to do that. Camera manuals are too tough? So are walking and chewing gum at the same time.