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:Documentation Production From:Aarti Shetty <aartishetty2005 -at- yahoo -dot- co -dot- in> To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 15 Dec 2004 01:02:01 +0000 (GMT)
Hi,
I am creating a User Guide for an existing thick and
thin client application. The User Guide is a PDF
deliverable. Where should the User Guide be located in
the product directory structure? The CM Manager
recommends that it should be a server component, and I
agree. I am writing to find out if there is a standard
location for product documentation in the product
directory structure, in such a scenario.
I would like to maintain the same directory structure
for ensuing versions of this product. Will this work
well, considering that the next release of the same
product will be a full thin client application? The
User Guide will continue to be a PDF deliverable.
Secondly, I will be creating the WebHelp deliverable
for both versions of the application. I concur with
the CM manager to have Help served from the server.
But, I am not sure which location to place the Help
system in the product directory structure.
My assignments so far have called for me to create and
check-in the documentation deliverables. I have always
worked in large documentation teams that have required
production managers to take decisions about the
documentation directory structure. I haven?t had a
chance in my previous assignments to understand why
documentation is located and served from specific
locations in the product directory structure. I am
currently the sole writer in the product group that I
am working with and I am faced with the challenge of
making production calls. I believe that I should have
stretched myself in my previous assignments to
understand all aspects of documentation. But I also
believe it isn?t too late to learn.
I will appreciate if senior writers who have made
production calls to help me understand the aspect.
Thanks,
Aarti
________________________________________________________________________
Yahoo! India Matrimony: Find your life partner online
Go to: http://yahoo.shaadi.com/india-matrimony
ROBOHELP X5 - SEE THE ALL NEW ROBOHELP X5 IN ACTION!
RoboHelp X5 is a giant leap forward in Help authoring technology, featuring all new Word 2003 support, Content Management, Multi-Author support, PDF and XML support and much more! View an online demo: http://www.macromedia.com/go/techwrldemo
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.