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.
> > 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.
>
I *am* discussing the explicit use of the word "you," hence the quotes and
my examples with and without "you" (the word, not the target of the
instruction). I do not have issues with imperative writing and the unstated
target, who can be interpreted by the reader as "you," "the service
technician," "the author," or "the sop that got stuck with the job." My
discussion is specifically focused on the use of the word "you." "You" is
not necessary in documentation.
Although some grammarians here refer to the "second-person imperative,"
absence of an explicit "person" can be interpreted as first, second, or
third person, since *no* person is even referenced.
"Click the widget to begin," can be interpreted as "____ must click the
widget to begin." "_____" can be the author, the reader, or the user, who
are first, second, and third persons respectively.
I don't interpret imperative writing as second-person focused, which would
mean that the document was written for me, the reader. When I am a reader
of documents, I am usually an editor and I am thinking about the user of the
document. In my head, I fill in the blank with "the user," a third person.
So for me, the document is sometimes third-person imperative. This is also
how I write. I don't know the grammatical terms for my writing preferences,
although, for me, "second-person imperative" is a misnomer.
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-
