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.
Hi,
Without blowing our own horn (should that be horns?)too much, we're
pretty happy with our tutorials. The feedback from users has been
entirely positive (with the exception of one typo). We created our older
tutorials using a nifty, open-source tool from IBM called Toot-O-Matic.
You develop the tutorial in XML, which is a great format for designing
effective outlines, etc. You can see an example of the output at http://www.capescience.com/education/tutorials/capestudio/tut17/index.ht
ml. I wrote an article on this process that appeared in the
always-riveting April, 2002 edition of the IEEE-PCS Newsletter. You can
read that article here: http://www.darrenbarefoot.com/writingsamples/Tootomatic.pdf
More recently, we've dispensed with the somewhat-labor-intensive
Toot-O-Matic approach and now create what amount to short, educational
movies using a tool called ViewletBuilder (from www.qarbon.com). They're
easy to make and users seem to really respond to them. You can see an
example of this approach (in fact, a later version of the tutorial I
referred to above) at http://www.capescience.com/education/tutorials/g4/helloworld/. Thanks.
DB.
> -----Original Message-----
> From: bounce-techwr-l-118566 -at- lists -dot- raycomm -dot- com
> [mailto:bounce-techwr-l-118566 -at- lists -dot- raycomm -dot- com] On Behalf
> Of Emily Goodin
> Sent: 22 January 2003 22:41
> To: TECHWR-L
> Subject: tutorial fomat - good examples?
>
>
>
> Sorry for the repetition - I forgot my Subject line....
>
> Greetings all,
>
> I'm creating a tutorial (document) and am looking for good
> examples - headings, organization, etc. - to give me some
> ideas. I found a bit of discussion on this topic in the
> archives, but not a lot. Any and all suggestions would be
> greatly appreciated!
>
> Emily
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
A new book on Single Sourcing has been released by William Andrew
Publishing: _Single Sourcing: Building Modular Documentation_
is now available at: http://www.williamandrew.com/titles/1491.html.
Help Authoring Seminar 2003, coming soon to a city near you! Attend this
educational and affordable one-day seminar covering existing and emerging
trends in Help authoring technology. See http://www.ehelp.com/techwr-l2.
---
You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.