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.
Subject:Product documentation PDFs and demos on a site From:rbilbao -at- us -dot- amadeus -dot- net To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 28 Aug 2003 13:51:47 -0400
Hello list,
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?
Your input is greatly appreciated.
Thanks!
Rhina
rbilbao -at- us -dot- amadeus -dot- net
**********************************************************************
This email message and information contained in or attached to this message
may be privileged, confidential, and protected from disclosure and is intended
only for the person or entity to which it is addressed. If you are not the
intended recipient any retransmission, dissemination, printing or other use of,
or taking of any action in reliance upon, this information is strictly prohibited.
If you received this message in error, please immediately inform the sender by
reply e-mail and delete the message and any attachments. This footnote also
confirms that this email message has been swept by MIMEsweeper for the
presence of computer viruses. Thank you.
**********************************************************************