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.
I am new to the biz of writing online help. I found myself having
to change my paradigm of writing rather explicitly to writing
minimally.
For example:
<minimal method>
Close
Closes the current window.
Instead of
<action verb method>
Use the Close command to close the current window.
or
<the wordy method>
The Close command closes the current window.
The "minimalist" information (Closes the current window) is a
sentence fragment, but I'm trying to convince myself that this
is indeed the best method because simpler is better. (Microsoft
uses this type of nonsentence construction as well.)
I'd like to hear some comments about wording your online help.
References to books or articles in the Journal of
Technical Communication are also welcome!
I'm looking for reassurance, but feel free to disagree with
my decision if you must! ;-)
