presents

Padgett Thompson
a division of Rockhurst University Continuing Education Center
Course Description

This seminar is offered onsite only. The descriptions and outlines specified below are examples of the topics covered in this seminar. Actual seminar content will depend on your organization's needs. Of course, we customize the seminar's content to meet the specific needs of your organization.

How To Write User Manuals: A Technical-Writing Workshop
A One-Day Seminar
Meeting Code: KZN

Whether you're writing instructions … procedures … or process explanations, you have the same goal - to make your manual as user-friendly as possible. In just six hours, we'll show you little-known tricks of the trade that will greatly simplify your job. Learn time-saving steps and shortcuts, ways to sharpen your writing and documentation skills and critical editing tips that ensure credibility. It's valuable, hard-won insight from experts that will enable you to develop professional work you can be proud of.

What You Will Cover ...

Time-Saving Tips and Shortcuts
 

• The 3 critical steps you must take before writing one word of a manual
• 4 special considerations you need to make for online manuals, otherwise your customers will click right past them
• A powerful prewriting strategy that'll keep your writing - and the manual - on target
• How technical writing pros map out manuals in advance so they can meet deadlines with ease
• Chronological … classification … spatial? Discover what technical style best suits your subject and readers
• Can you ever do too much research? How to tell when it's time to stop studying and start writing
• How to "hook" your readers from the start so you can be certain they'll understand vital directions
• How to accurately document software applications and computer systems
• When you still have pages and pages to fill … the secret to overcoming writer's block (it works every time)
• Setting up links within your online manual that will have users singing your praises - and keep them coming back
• How to demystify complicated subjects and zero in on what a reader needs to know
• Table of contents or index? The pros and cons of each
• How to strike a balance between writing at the audience's level and talking down to readers
• Words and phrases that virtually guarantee you'll end up with confused readers (and a manual they barely touch)
• When you can't avoid using technical terms … how to make sure every reader gets the point
• Giving credit where it's due: The crucial dos and don'ts of footnotes … recognizing authors … and copyrights

Make Every Page User-Friendly
 

• A proven-effective method for finding out if your copy is too high-tech for your audience
• How to structure your online manual to take advantage of online reading behaviors
• How to put a manual format to the test so you can find out if it'll be a help - or hindrance - to readers
• When an illustration can be deadly to technical copy … and when it's absolutely critical for manual clarity
• How to prolong the life of your manual by making it easy for readers to update
• When quick and easy is your goal: How to set up tabs … reference sections … and other user-friendly guideposts
• 3 design principles every manual writer should be aware of … ignore them at your copy's risk
• When there are volumes devoted to your subject … how to quickly cut to the heart of the matter

Expand Your Editing Expertise
 

• The 1 rule you can't afford to forget when you're editing your own work
• How to develop a "Reader's Eye" so you can see a mountain of pages from a fresh perspective
• Putting the finishing touches on your online manual: Readability, screen design and graphics
• FINALLY! The critical ingredients every good user manual contains … skip even one and all your hard work could be wasted
• Bridge or roadblock? The surprising impact sentence structure has on manual users
• 2 common error "hideouts" that even experienced proofreaders can miss in a multi-page manual
• UPDATE! How to safely navigate through murky legal issues

Who Should Attend ...

Anyone who wants to write business documents or technical information in a clear, easy-to-read style.

For information about bringing a course to your site please call 1-919-847-0331 or email the registry at .

If this course or the dates/locations below do not have what you are looking for, then click here and we will find it for you right away. It will save you a lot of time and energy finding it yourself.

Please mention the meeting code specified above and BE SURE TO STATE PRIORITY CODE "919-120001-000 -- Training Registry".