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.
Ben wondered: <<For those of you who edit Online Help written by
other authors, I'd like to ask this question. How do you mark up the
Help and give it back to authors?>>
You have a range of possible solutions. If the help is being written
in Word*, then that's the easiest solution: edit using revision
tracking, review the edits, then compile the final help file. If not,
you can copy or export the text to Word so you can use revision
tracking to clearly indicate changes and insert substantive comments;
it's easy to review the comments and either manually make the same
changes in the authoring software (which risks introducing new
errors) or copy the final text back into the authoring software
(which also isn't perfect, but at least reduces the risk).
* Here and elsewhere, substitute any other word processor that uses
revision tracking, including WordPerfect and OpenOffice, if you prefer.
If you don't want to do the copy/paste bit, and do want to try using
revision tracking, you can sometimes "round-trip" the edits using an
intermediate format such as RTF or HTML that exports neatly from your
authoring software and can be opened in Word. RTF is pretty good for
round-tripping and allows you to use revision tracking. HTML is a bit
trickier (see my description of how to do this in the techwr-l
archives) since you have to basically use Word as an ASCII text
editor rather than as a "save the file in Word HTML format", but it
works very well indeed.
However you proceed, the goal is to clearly indicate changes so that
the authors who must review the changes, see what you've done, and
approve or reject each edit. Details of a range of potentially
suitable approaches are provided in Chapters 12 and 14 of my book
(see link below my signature), plus some thoughts about proofreading
online documents in Chapter 16.
-- Geoff Hart
ghart -at- videotron -dot- ca / geoffhart -at- mac -dot- com
***Now available*** _Effective onscreen editing_
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-