Creating online tutorials

Subject: Creating online tutorials
From: "Sonja McShane" <sonjamcshane -at- gmail -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Wed, 27 Aug 2008 11:25:08 +1000

Hi everyone,

Time to 'unlurk' and ask for help, please! I need to create some tutorials,
using MadCap Mimic, about my company's software products. I think I could
probably do a reasonable job with what I already know about tech writing,
but I really want these tutorials to be outstanding.

I've done some preliminary searching for information about creating
tutorials and what makes a good tutorial, but oddly enough there doesn't
seem to be much around. I'd really appreciate it if anyone could pass on

- tips about writing tutorials
- 'gotchas' I should know about
- links to examples of excellent online, interactive tutorials
(preferably explaining how to use software)
- links to how to write tutorials
- 'pet peeves' about tutorials you've used in the past.

If you could please send the details to me at sonja -dot- mcshane -at- str -dot- com -dot- au,
and I'll post a summary in the next few days.

Thanks very much,

Sonja McShane

Senior Technical Writer

Space-Time Research Pty Ltd

Level 1 630 Church Street


ComponentOne Doc-To-Help gives you everything you need to author and
publish quality Help, Web, and print content. Perfect for technical
authors, developers, and policy writers. Download a FREE trial.

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity!

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit for more resources and info.


Previous by Author: Re: How did you get started in tech writing?
Next by Author: RE: The "Perfect" Course of Study for a Technical Writer
Previous by Thread: RE: Moving to Word 2007
Next by Thread: Creating online tutorials?

What this post helpful? Share it with friends and colleagues:

Sponsored Ads