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 Guide - a newbie mistake? From:John Posada <JPosada -at- book -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 19 Sep 2002 17:09:08 -0400
Nobody ever covers "absolutely every aspect of the software" and we call our
documentation alot of things...sometimes we call it a User Guide.
Seriously...you are creating a User Guide...a guide for the user..what the
user doesn't need, you don't include, and the use doesn't need "absolutely
every aspect of the software".
John Posada
Senior Technical Writer
Barnes&Noble.com
jposada -at- book -dot- com
212-414-6656
"Be accurate...the 4am wakeup call you prevent could be your manager's"
-----Original Message-----
From: rbilbao -at- us -dot- amadeus -dot- net [mailto:rbilbao -at- us -dot- amadeus -dot- net]
Sent: Thursday, September 19, 2002 5:05 PM
To: TECHWR-L
Subject: User Guide - a newbie mistake?
Hi everyone,
Dilemma: I'm almost done with my first document. It's 20 pages long. I
called it
a user guide and sent it for review. Then I realize, I didn't really cover
absolutely every aspect of the software. I covered about 75%. The important
75%.
Is it okay to have called it a user guide? Is there a rule that says when
calling a document a user guide it has to cover 100% of everything? Or does
it
depend on what the company/team/department has deemed "user guide" for
consistency?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Experience RoboHelp X3! This new RoboHelp release combines single sourcing,
print-quality documentation, conditional text and much more, into the most
monumental release of RoboHelp ever! http://www.ehelp.com/techwr-l
FrameMaker-to-PDF TimeSavers Assistants let you enhance & automate navigation
in PDF doc sets (chapter tabs, next/prev chapter/pg, bookmarks, popup menus);
create interactive PDF forms, rollover popups; presentations: http://www.microtype.com
---
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.
