Re: Help topic question

Subject: Re: Help topic question
From: Kathleen MacDowell <kathleen -dot- eamd -at- gmail -dot- com>
To: Joe Weinmunson <litlfrog -at- gmail -dot- com>
Date: Fri, 3 Feb 2017 12:30:15 -0600

In my experience, when there is more than one way to do something, describe
the easiest simplest way, from the user's perspective. You can note that
fact in preface content if you think it's necessary, e.g., "procedures a,
b, c are listed according to preferred method. See Appendix X for
procedures b & c." All in your own words obviously.

The only time it might be important to describe all variations is if there
might be dire consequences if a person made a mis-step along the way.

On Fri, Feb 3, 2017 at 12:18 PM, Joe Weinmunson <litlfrog -at- gmail -dot- com> wrote:

> This might be a beginner's question, but while I've done plenty of academic
> writing I never received any formal training in tech writing. I'm supposed
> to be updating the topics in this Help file to be in a numbered list format
> where feasible. You can see the file in progress at
> http://roleplayhistory.com/trashflow/AddCustomer.pdf
>
> I'm not sure of the best way to handle "if . . . then" situations. There
> are three ways a user could proceed in filling out part of the address; two
> are common, one is not. Can anyone point me in the direction of some advice
> on how to proceed? Any help appreciated.
>
> --
> Joe Weinmunson
>
> âWhat you read when you donât have to determines what you will be when you
> canât help it.â
> --Oscar Wilde
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> Visit TechWhirl for the latest on content technology, content strategy and
> content development | http://techwhirl.com
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> You are currently subscribed to TECHWR-L as kathleen -dot- eamd -at- gmail -dot- com -dot-
>
> To unsubscribe send a blank email to
> techwr-l-leave -at- lists -dot- techwr-l -dot- com
>
>
> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
> http://www.techwhirl.com/email-discussion-groups/ for more resources and
> info.
>
> Looking for articles on Technical Communications? Head over to our online
> magazine at http://techwhirl.com
>
> Looking for the archived Techwr-l email discussions? Search our public
> email archives @ http://techwr-l.com/archives
>



--
Kathleen MacDowell
kathleen -dot- eamd -at- gmail -dot- com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.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-leave -at- lists -dot- techwr-l -dot- com


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

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


References:
Help topic question: From: Joe Weinmunson

Previous by Author: Re: What would you do?
Next by Author: Re: What would you do?
Previous by Thread: Help topic question
Next by Thread: RE: Help topic question


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

Sponsored Ads


Sponsored Ads