RE: Repeat? Consequence of an action in an application

Subject: RE: Repeat? Consequence of an action in an application
From: "Sharon Burton" <sharon -at- anthrobytes -dot- com>
To: "Rob Hudson" <caveatrob -at- gmail -dot- com>, "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 19 Nov 2008 09:59:41 -0800

[Warning, still recovering from changing 9 time zones. May be slightly
incoherent.]

Teach your students that all results (actions, too) should be written from
the point of view of your audience. While, in fact, the application does
stuff, writing user-centric results in more...coherent and applicable to the
user phrasings.

It also helps the reader because you are showing them why they care all the
time. People don't really care that the application does stuff, they care
that stuff they need to do or know is happening.


For example:
(Product centric)
* The application shows the "home" screen, which contains your profile.

(User-centric)
* The "home" screen appears, showing your profile (last name, address, etc).
(better)
Your profile appears on the Home screen. Your name and address are listed.


sharon

Sharon Burton
951-369-8590


-----Original Message-----
From: techwr-l-bounces+sharon=anthrobytes -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+sharon=anthrobytes -dot- com -at- lists -dot- techwr-l -dot- com]On
Behalf Of Rob Hudson
Sent: Wednesday, November 19, 2008 9:44 AM
To: TECHWR-L
Subject: Repeat? Consequence of an action in an application


I'm teaching my students to write instructions. For each step, I ask for
an action and a consequence. For example, if you are at a login screen
and you type your username and password, and press "Save," a "home"
screen might appear showing a user's profile.

I'm having trouble explaining a nice way to indicate that consequence or
effect. Some options;

* The "home" screen appears, showing your profile (last name, address, etc).
* The application shows the "home" screen, which contains your profile.

What's the cleanest, clearest way to express an effect in terms of an
application? I'm having trouble demonstrating a consistent, clear phrasing.


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

ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing
solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or
HTML and publish to the Web, Help systems or printed manuals.
http://www.doctohelp.com

Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/

---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -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%40web.techwr-l.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:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


References:
Repeat? Consequence of an action in an application: From: Rob Hudson

Previous by Author: RE: Is there a study on reading warnings, notes?
Next by Author: RE: "Sorry you're not the right fit" - After "all is fine" for 4 weeks
Previous by Thread: Repeat? Consequence of an action in an application
Next by Thread: RE: Repeat? Consequence of an action in an application


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


Sponsored Ads