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:Re: User's guide for Web applications? From:Tara English-Sweeney <tesweeney -at- novadigm -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 28 Aug 2001 11:16:13 -0400
Hi Laura.
This discussion is very interesting and quite timely. I am currently
documenting a new Web-based application and it's still kind of up in the air
as to how the doc will be delivered. Right now, I have been told to proceed
as we usually do.
We have some other Web-based apps, with limited documentation. Historically,
our company has created printed books that are delivered with the software
(not Web-based). The same material is then made available to our customers
via HTML and PDF on our Web site. I would love to see this change -
especially with this latest project.
In general, I think that users should be able to access targeted (embedded)
information, as well as detailed information, from within a Web-based
product. I also think users should have the option to print information.
So, FWIW here are my thoughts on your questions:
* I would try to contain all information in one source, if possible.
But, this really varies based on your product, audience, and so many other
things...I don't think users should have to bounce around from source to
source to get the information they need.
* Are you suggesting no step-by-step information? It's hard to say
without knowing the details of your situation, but I would reconsider that
decision.
* Regarding how often we update the PDFs - not enough but that's for
many reasons - including a small staff and a lot of information/products
that changes all the time. Again, it's hard to say not knowing the
specifics. Would once a quarter be enough? How often does the product
change? In the beginning, you may need to do more updates as you iron out
the documentation.
* Yes, we include screen shots, and it adds to the things that need to
maintained in the doc. But, users seem to find them helpful, and if we're
updating the doc anyway...
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at http://www.devahelp.com or info -at- devahelp -dot- com
A landmark hotel, one of America's most beautiful cities, and
three and a half days of immersion in the state of the art:
IPCC 01, Oct. 24-27 in Santa Fe. http://ieeepcs.org/2001/
---
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.
