Online Help Editors? (take II)

Subject: Online Help Editors? (take II)
From: Geoff Hart <ghart -at- videotron -dot- ca>
To: TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com>, Ben <baj357 -at- gmail -dot- com>
Date: Wed, 18 Jul 2007 15:07:10 -0400

Ben wondered: <<I would appreciate if you'd be so kind as to give
your insight on developmental editing for Online Help, for example,
re-organizing topics and books in a Help project. I'm thinking about
sending a revised outline of their Help Contents in MS Word so the
authors can compare against their original Help project.>>

Strictly speaking, developmental editing should occur before anyone
actually begins writing. In a way, you can think of this as a form of
prototyping in which you do most of the design work up front, then
test the resulting design to ensure that it's effective. (Don't you
wish they designed software that way?) For some thoughts on this:
http://www.geoff-hart.com/resources/2006/prototype.htm
http://www.geoff-hart.com/resources/2006/outlining.htm

It's also helpful to combine developmental and substantive editing at
the start of any project. In effect, once you've got a kick-ass
outline in place, you then try writing an actual topic that fits
within the outline, and beat hell out of that topic until everyone is
basically satisfied that it's the best approach you can come up with.
Then you standardize on that approach. What this accomplishes is that
you solve as many problems as possible right from the start, then
avoid creating those problems from that point onwards. Compare this
with the joy of fixing each problem 1000 times because it reoccurs in
each of the 1000 help topics in a large project and the saving is
obvious!

Of course, more realistically, you can solve only some of the
repeating problems, and have to invent solutions to new ones as you
encounter them. In addition, some authors will do a better job than
others of internalizing this aproach and writing well without
creating the same problems in each help topic. This suggests that
some iteration and continuous improvement will be necessary. Creating
a strong style guide that is easy for authors to use and that is
supported by good templates and other tools can help greatly. For
some thoughts on how to make such a style guide:
http://www.geoff-hart.com/resources/2000/dynamicstyle.htm


----------------------------------------------------
-- Geoff Hart
ghart -at- videotron -dot- ca / geoffhart -at- mac -dot- com
www.geoff-hart.com
--------------------------------------------------
***Now available*** _Effective onscreen editing_
(http://www.geoff-hart.com/home/onscreen-book.htm)


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

Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more.
http://www.DocToHelp.com/TechwrlList

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.


Follow-Ups:

References:
RE: Online Help Editors?: From: Ben

Previous by Author: Online Help Editors?
Next by Author: Serif & sans serif fonts?
Previous by Thread: RE: Online Help Editors?
Next by Thread: RE: Online Help Editors? (take II)


What this post helpful? Share it with friends and colleagues:


Sponsored Ads