Re: Must documentation always follow the UI?

Subject: Re: Must documentation always follow the UI?
From: deloaa <deloaa -at- yahoo -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Thu, 24 Sep 2015 08:59:04 -0700

Ditto.

There's a difference between writing for a novice user and a more experienced user. Once I learn a product, I abhor slogging through documentation written only for a novice to clarify a single term. Depending on the degree of complexity of your product and the nature of its audience, a glossary might prove useful.

All the best,

Amelia DeLoach


--------------------------------------------
On Wed, 9/23/15, Mike Starr <mike -at- writestarr -dot- com> wrote:

Subject: Re: Must documentation always follow the UI?
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Wednesday, September 23, 2015, 2:34 PM

It's not always all
about task-based documentation. There is a time and
place for reference documentation. At some
point, users need to be able
to understand
every UI element even when we don't provide them with

documentation for a task that uses that
particular element.

Best
Regards,

Mike
--
Mike Starr           
                 WriteStarr Information
Services
Technical Writer   - 
  Online Help
Developer   -   WordPress Websites
Graphic Designer - Desktop Publisher - Custom
Microsoft Word templates
(262)
694-1028   -  mike -at- writestarr -dot- com   - 
http://www.writestarr.com
President - Working Writers of Wisconsin http://www.workingwriters.org/

On 2015-09-23 2:26 pm, John G wrote:
> I try not to build a monument to the UI if
I can possibly avoid it. The
> UI
> exists in the code - why does it have to
be reiterated in the
> documentation?
>
> If you're
writing task based content, just tell them how to use the UI

> -
> Click
"Abercrombie" to order high-markup clothes for
preppies - but you
> don't have to
recount how and in what order things are organized on the
> page - they can see that.
>
> And if you are
presenting the contents of the page, for example, as
> links
> to more
information, I'd take a stab at listing the ones most
likely to
> be
> used
first, and the ones least likely to be used last.
>
> tldr; Don't
describe the page in words, and consider what the user is

> doing
> with the
page and cater to their needs.
>
> My 2¢,
>
> JG
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Learn more about Adobe Technical Communication
Suite (2015 Release) | http://bit.ly/1FR7zNW

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

You are currently subscribed
to TECHWR-L as deloaa -at- yahoo -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

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Learn more about Adobe Technical Communication Suite (2015 Release) | http://bit.ly/1FR7zNW

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

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:
Re: Must documentation always follow the UI?: From: Mike Starr

Previous by Author: Re: Learning XML
Next by Author: Optimal line length for sales documents in pdf
Previous by Thread: Re: Must documentation always follow the UI?
Next by Thread: Re: Must documentation always follow the UI?


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

Sponsored Ads


Sponsored Ads