RE: levels of detail -- are we beyond this?

["Lauren" <lauren -at- writeco -dot- net>]

When I work with a company that requires such basic instructions for its
users, I create a section for basic tasks, perhaps, something like, "Web
Navigation Basics."  I make sure that headings are cogent enough for
knowledgeable users to skim the section and see that they do not need these
basic instructions.  

For one client, a particular business process required some intermediate
knowledge for using Excel.  In that case, I had a section called, "Using
Excel."  The low level user, usually not a high school graduate, had
necessary information for getting started with the program and the higher
level users could just skip the section.  

I do not combine these basic instructions with the more advanced,
application-specific instructions.  Although, when it seems necessary, I
provide a note about referring to the "basics" section to learn to use the
application.

Lauren
 

> -----Original Message-----
> From: techwr-l-bounces+lauren=writeco -dot- net -at- lists -dot- techwr-l -dot- com 
> [mailto:techwr-l-bounces+lauren=writeco -dot- net -at- lists -dot- techwr-l -dot- com
> ] On Behalf Of Tom Johnson
> Sent: Friday, August 15, 2008 12:56 PM
> To: TECHWR-L'
> Subject: levels of detail -- are we beyond this?
> 
> I just ran into some detailed instructions on going to a 
> website that look
> like this:
> 
>    1. Open Internet Explorer by clicking *Start* > *Programs* 
> > *Internet
>    Explorer*.
>    2. In the *Address* field, enter *http://sampleurl.com* 
> and press *Enter*.
> 
> 
> Is it me, or is this kind of detail totally unnecessary in 
> this day and age?
> I'd say 99% of the time, people will understand the much 
> simpler version:
> "1. Go to http://sampleurl.com.";
> 
> Tom
> 
> ---------------------
> cell: 801-822-2241
> blog: www.idratherbewriting.com
> twitter: www.twitter.com/tomjohnson
> news: www.writerriver.com
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> 
> ComponentOne Doc-To-Help gives you everything you need to author and 
> publish quality Help, Web, and print content. Perfect for technical 
> authors, developers, and policy writers. Download a FREE trial.
> http://www.componentone.com/DocToHelp/
> 
> 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 lauren -at- writeco -dot- net -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/lauren%40wr
> iteco.net
> 
> 
> 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.
> 

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

ComponentOne Doc-To-Help gives you everything you need to author and 
publish quality Help, Web, and print content. Perfect for technical 
authors, developers, and policy writers. Download a FREE trial.
http://www.componentone.com/DocToHelp/

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- 

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.