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: Two Professional Questions From:Wade Courtney <wade -dot- courtney -at- gmail -dot- com> To:Dan Goldstein <DGoldstein -at- riverainmedical -dot- com> Date:Mon, 27 Sep 2010 11:55:11 -0700
What, exactly, is well-laid-out application documentation? Is there an
example somewhere, so I can see if I'm doing anything wrong?
//uses word as an output mechanism.
On Mon, Sep 27, 2010 at 11:41 AM, Dan Goldstein
<DGoldstein -at- riverainmedical -dot- com> wrote:
> I'm thinking about all those tech writers who use Word to create
> well-laid-out application documentation, and who aren't "faced with a
> battle every step of the way."
> What are they missing? Where have they gone wrong, without anyone
> -----Original Message-----
> From: Chris Morton
> Sent: Monday, September 27, 2010 2:22 PM
> To: techwr-l -at- lists -dot- techwr-l -dot- com
> Subject: Re: Two Professional Questions
> As for Frame, it may be overkill, depending on both the project
> requirements and the entity that is contracting you. For many smaller
> projects, I believe InDesign is the tool of choice.
> I would never consider Word for any application documentation, period.
> It simply does not measure up as a layout application that also offers
> things like TOC generation and the like. (Yes, Word can do be made to do
> many of these things in a pinch, but you'll be faced with a battle every
> step of the way.)
> This message contains confidential information intended only for the use of the addressee(s). If you are not the addressee, or the person responsible for delivering it to the addressee, you are hereby notified that reading, disseminating, distributing, copying, electronic storing or the taking of any action in reliance on the contents of this message is strictly prohibited. If you have received this message by mistake, please notify us, by replying to the sender, and delete the original message immediately thereafter. Thank you.
> Create and publish documentation through multiple channels with Doc-To-Help.
> Choose your authoring formats and get any output you may need. Try
> Doc-To-Help, now with MS SharePoint integration, free for 30-days.
> LavaCon 2010 in San Diego Sept 29 - Oct 2 is now open for registration.
> Use referral code TECHWR-L for $50 off conference tuition!
> See program at: http://lavacon.org/
> You are currently subscribed to TECHWR-L as wade -dot- courtney -at- gmail -dot- com -dot-
> To unsubscribe send a blank email to
> techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
> or visit http://lists.techwr-l.com/mailman/options/techwr-l/wade.courtney%40gmail.com
> To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com
> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
>http://www.techwr-l.com/ for more resources and info.
> Please move off-topic discussions to the Chat list, at:
Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days. http://www.doctohelp.com
LavaCon 2010 in San Diego Sept 29 - Oct 2 is now open for registration.
Use referral code TECHWR-L for $50 off conference tuition!
See program at: http://lavacon.org/
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-