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.
Re: document design: I don't know what I don't know
Subject:Re: document design: I don't know what I don't know From:Chris Morton <salt -dot- morton -at- gmail -dot- com> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Wed, 29 Aug 2012 13:44:57 -0700
On Wed, Aug 29, 2012 at 1:35 PM, Lauren <lauren -at- writeco -dot- net> wrote:
What she said.... oh, and you gotta write real good. *;<)*
On a serious note, I'd like to stress the need for unambiguous instructions
when tech writing. For starters, be careful of using too many pronouns! Sit
back and reread your work aloud as if you're an intended reader... could
the instruction set be misinterpreted in any way?
> Chris
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
