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: Do you permit SMEs to revise your drafts? From:John Cornellier <cornellier1 -at- stavanger -dot- oilfield -dot- slb -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 02 Dec 2003 18:32:16 +0000
One of my docs is a database server admin guide (-ish type thing). Mainly lists of parameters, not much prose.
I've put it onto a TWiki server. So it is very easy to update, in a web browser, and has full version control. It is a "living document" : whenever developers revise code that means a doc update, they just do it.
When we commercialize the product, I put a freeze on the doc, do a sanity check, add it to the test plans, then do a TWiki > publishing tool du jour > PDF > add it to the baseline workflow.
The idea is to make it as easy as possible to update the content, and to separate the content from form.
We don't have problems with formatting getting "mucked up" (as someone said) because the format is minimalist -- four levels of heading, bulleted lists, numbered lists, tables, one font format for monospace. That's about it.
It works.
John Cornellier
mandag 1. desember 2003, 16:22, skrev patricia -dot- blount -at- ca -dot- com:
> In general, do you permit your SMEs to revise your drafts directly, or to
> report their concerns to you?
RoboHelp for FrameMaker is a NEW online publishing tool for FrameMaker that
lets you easily single-source content to online Help, intranet, and Web.
The interface is designed for FrameMaker users, so there is little or no
learning curve and no macro language required! Call 800-718-4407 for
competitive pricing or download a trial at: http://www.ehelp.com/techwr-l4
---
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.
