Engineers as authors

Michael Norton mnorton at openspan.com
Tue Oct 8 06:16:29 PDT 2013


I recommend...


-          Creating a simple Word template - if Word is their tool of choice - which will make it easy to import their content into Frame.

-          Provide some very brief documentation on how to use this template (use the styles, keep it plain, don't worry about ToCs, and so on)

-          If you have a Style Guide, make it available to them (but don't expect much)

-          Go through a review cycle early on, where you see where there are going with the content and you make edits to the Word doc

-          Be available to answer questions and encourage/monitor progress

-          Set expectations that they will be providing content which you will then edit and publish

The first three can be done in a meeting/webex.

I've done a fair amount of this and each engineer is different. Some will do an excellent job and will only require minor editing. Others, not so much. Some think every word they write is sacred and you are just a formatter. Others are happy to have you help them make their pet project look good.

In many cases, the process can help you develop an even better relationship with an SME.


................................................................................................................................................................................................

Michael Norton | Technical Writer


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.frameusers.com/pipermail/framers-frameusers.com/attachments/20131008/d0eb5866/attachment.htm>


More information about the framers mailing list