RE: The second person in user guides

Subject: RE: The second person in user guides
From: "Tom Storer" <tstorer -at- free -dot- fr>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 6 Dec 2005 09:50:56 +0100

Beth Agnew said (to Wallace Sagendorph):

"It always comes back to audience. What is the best style for your
customers? While the 'you' is implied in the imperative, you may have
occasion to address the reader directly."

I agree with this. However, Wallace, if you do go for a more "casual"
2nd-person approach than you're used to, remember that the imperative is
better when there really is something the user *must* do at that point.
Sometimes in order to create a warm and cheery atmosphere, writers shy away
from being explicitly directive and giving orders. This can lead to saying
"You should do XYZ" or "you can do XYZ to get result ABC" in situations
where the user in fact needs to be told "Now do XYZ. The result is ABC."
Personally I avoid "you should"s--if I have a recommandation to make I call
it a recommendation, otherwise it's either an order or options to be
explained.

- Tom Storer


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today! http://www.webworks.com/techwr-l

Doc-To-Help 2005 now has RoboHelp Converter and HTML Source: Author
content and configure Help in MS Word or any HTML editor. No
proprietary editor! *August release. http://www.componentone.com/TECHWRL/DocToHelp2005

---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -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/archive%40infoinfocus.com

Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.


Previous by Author: Re: Rule of thumb for doc time based on development time?
Next by Author: RE: what are you working on today
Previous by Thread: Re: The second person in user guides
Next by Thread: Legal framework for consultancy work


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads