TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
> > In the instructions, every procedure is
> > followed by the result .... However, I AM
> > interested in your thoughts.
>
> My thoughts are that it is:
>
> 1. Unnecessary except when writing for novices
> to tell them that when they click 'xyz' something
> called 'xyz' will appear on the screen -- especially
> when the next instruction ASSUMES the presence
> of the 'xyz' thing.
I think the concept of Novice is a relative thing. Someone who would
be an expert when using a simple application might come off as a
novice when using a very complex application. Therefore, the more
complex the application, the more I write in the style that would be
used for the level of application.
> 2. Inconsistent with good structured writing
> practice to insert things that are not instructions
> into a list of instructions.
Again, when an application can display a variety of different screens
depending on fractors that are not obvious, or may be dependant on
variables that were entered by someone else, I think it is important
to include the confirtmation that what you expect to receive, you do
receive.
This needs to be said over and over...you write for the reader, and
you write for the situation. Rules (such as the current one on number
of steps) should be used as guidesm not as hard and fast
requirements. IN the case of the step numbers, 7 steps may be the
maximum for a certain level of complexity. OTOH, it is possible that
you have a process that is SO complex that the person might loose
their way after three steps.
__________________________________________________
Do You Yahoo!?
Yahoo! Shopping - Thousands of Stores. Millions of Products. http://shopping.yahoo.com/
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Develop HTML-based Help with Macromedia Dreamweaver! (STC Discount.)
**NEW DATE/LOCATION!** January 16-17, 2001, New York, NY. http://www.weisner.com/training/dreamweaver_help.htm or 800-646-9989.
Take XML and Tech Writing courses online! Our instructor-led courses
(4-6 hrs/wk) give you "hands on" experience at your convenience. STC members
get 20% off! http://www.online-learning.com/index.html.
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
