TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
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
any:
- 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
Sonja McShane
Senior Technical Writer
Space-Time Research Pty Ltd
Level 1 630 Church Street
RICHMOND VIC 3121 AUSTRALIA
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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. http://www.componentone.com/DocToHelp/
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-