Re: Do you permit SMEs to revise your drafts?

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 TRIAL NOW AVAILABLE!

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.



Previous by Author: Re: your tool suggestion for Web development
Next by Author: OOo -> PDF?
Previous by Thread: Re: Do you permit SMEs to revise your drafts?
Next by Thread: RE: Do you permit SMEs to revise your drafts?


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


Sponsored Ads