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.
On Behalf Of Lauren
> Sent: Friday, January 18, 2008 14:04
> > From: Ben
> > A possible guideline is use the word, you, in
> > non-procedural content, but avoid it otherwise. On that
> > note, what are your thoughts about using imperatives in
> > non-procedural content?
>
> When would a writer need to refer to "you" in non-procedural content?
I
> will address "you" in email and other informal correspondence, but
that's
> pretty much the extent of my use of the word.
>
> I've seen documents written with phrases such as, "use this procedure
when
> you need to access the system," but the use of "you" in these cases is
> unnecessary because the phrase still works without "when you need." I
> prefer to say what needs to be said with the fewest words possible
while
> keeping the document effective and comfortable to read. I don't see
where
> "you" is necessary to improve documentation and, for me, it makes the
> writing more uncomfortable to read.
You are using it anyway.
When you say "Do X.", the "you" is implied.
You, Lauren, stop typing, right now.
You, stop typing, right now.
Lauren, stop typing, right now.
...
OK, [you] resume typing.
:-)
Kevin
The information contained in this electronic mail transmission
may be privileged and confidential, and therefore, protected
from disclosure. If you have received this communication in
error, please notify us immediately by replying to this
message and deleting it from your computer without copying
or disclosing it.
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-