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.
Re: Product documentation PDFs and demos on a site
Subject:Re: Product documentation PDFs and demos on a site From:Susan W. Gallagher <sgallagher5 -at- cox -dot- net> To:rbilbao -at- us -dot- amadeus -dot- net,"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 28 Aug 2003 16:58:48 -0400
Well... It depends! ;-)
Some users may consider a demo part of the documentation,
perhaps because they're visual learners. Others won't. As
far as the demos being included in the documentation section,
I could go either way.
My only concern is that if the demos are all in a section
called "Product Documentation", nobody who is looking for
demos will be able to find them, so if you choose to leave
them there, you might want to rename the section to
"Documentation and Demos" or some such thing.
-Sue Gallagher
>
> From: rbilbao -at- us -dot- amadeus -dot- net
> I'm writing to request your expert opinions. My department has documentation on
> software products in a section of our training and support site aptly named
> Product Documentation. It includes User Guides, Installation Guides, Quick
> References... you know, standard stuff.
>
> Later, we made Flash demos of some of our products and stuck them in there, too.
> Now I'm overhauling the section (making the PDFs more useful thanks to
> suggestions I read about on this list!) and I think that demos really don't
> belong in this section, but in their own separate section. In the beginning,
> there were only two, but now there are six and it will probably continue to
> grow. Some of my team members disagree, stating that demos are a form of product
> documentation.
>
> I think that if the user looks in the product documentation section of a
> training site, they most likely already own the product and just need to know
> how to use it. The demos are mainly sales tools that focus on the features and
> benefits (not "how-to" information.) I can't ask the users themselves right now,
> so what do you think?
