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.
Nancy...you should not do any of them unless you have a reason FOR
doing them.
Your existing help. Have people expressed problems? Have they asked
questions that would lead you to believe that any of the elements you
listed would eliminate the question?
Would added colors contribute to its understanding? Would pictures
allow greater depth and dimension to your explainations? has your
boss said "Geezz...this stuff is boring...can you spruce it up?"
Keep in mind that whatever you add, you are adding to the
maintenance. Are you taxed on maintenance resources now?
Before I were to start changing look and feel or additional
information, I'd make sure that what you have is spot on. When was
the last time you took each topic and examined it closely against the
current version of the application. Sometimnes the application
evolves and the help doesn't evolve at an equal rate. When I open a
topic and it isn't exactly right or tweaked for the current
application version, I never think "Yeah, but look at all the pretty
colors!"
As you are reading or rewriting the topic, the need to add elements
such as product overview or explanations of why a user might perform
a given procedure. The topic will let you know...not the list.
When I was sure that each and every topic was written the best it
could be, then I might look at the appearance. Want to goose the
appearance real fast with little effort? Icons. Without going
overboard and with taste, little icons such as check marks, arrows,
etc. Another thing that will freshen up the look with minimum effort
is things you can apply by making a change to the style. Redefine the
H1 style to a little larger font using an attractive color, maybe a
nice maroon or navy blue on a cream background.
However, don't choose style over substance. With time, I can always
think of additional work I'd like to do on the content of the topic.
__________________________________________________
Do You Yahoo!?
Yahoo! GeoCities - quick and easy web site hosting, just $8.95/month. http://geocities.yahoo.com/ps/info1
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
