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.
Subject:RE: Request for Ideas (Long) From:"Steve Hudson" <cruddy -at- optushome -dot- com -dot- au> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Sat, 19 Jan 2002 08:21:10 +1100
I don't think this is a big a hassle as people make out. All my user guides
have only one full-screen shot of the app - otherwise its just a picture of
the button that invokes it etc. If variable elements are unavoidably
captured inshot, paint them out.
Document the function as per normal, including shots of any dialogs invoked
etc.
If a dialog itself has variable content, you can note this at the start of
the topic for that dialog, and use a literary device like an asterix to mark
functions that may or may not be present.
Have a link at the bottom of the topic to another topic describing the
variables that affect the dialog's content.
But really, if your TASK topics are adequate, they should guide the user
seemlessly through the experience on a task path, regardless of variability.
Include tutorials, or task paths, for radically different task streams.
Steve Hudson, Word Heretic
HDK List MVP
Word help and tools: heretic -at- tdfa -dot- com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Collect Royalties, Not Rejection Letters! Tell us your rejection story when you
submit your manuscript to iUniverse Nov. 6 -Dec. 15 and get five free copies of
your book. What are you waiting for? http://www.iuniverse.com/media/techwr
---
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.