Re: Engineers as authors

[Lin Sims]

You can lock it down. We've done something similar where I work--created a
Word template with the styles named the same way as in our Frame template,
and then locked the Word template to prevent on-the-fly formatting. The
engineers vacillate between loving it (everything's already set up! yay!)
and hating it (why can't I use Bold anymore? Wah!), but it surely makes
life easier for US.


On Wed, Oct 16, 2013 at 2:08 PM, Robert Lauriston wrote:

> Nice to hear you're not going to make that common mistake.
>
> Supposedly you can lock down Word templates these days to restrict
> styles to a defined list. I'll believe it when I see it.
>
>
> On Wed, Oct 16, 2013 at 11:00 AM, Stephen O'Brien
>  wrote:
> >
> > Your answers actually helped me nudge an existing project in a different
> direction. The engineers were being asked a level of writing that was
> beyond their abilities and a negative attitude was developing with regards
> to contributing expert content.
> ___
>
>
> You are currently subscribed to framers as ljsims...@gmail.com.
>
> Send list messages to framers@lists.frameusers.com.
>
> To unsubscribe send a blank email to
> framers-unsubscr...@lists.frameusers.com
> or visit
> http://lists.frameusers.com/mailman/options/framers/ljsims.ml%40gmail.com
>
> Send administrative questions to listad...@frameusers.com. Visit
> http://www.frameusers.com/ for more resources and info.
>



-- 
Lin Sims
___


You are currently subscribed to framers as arch...@mail-archive.com.

Send list messages to framers@lists.frameusers.com.

To unsubscribe send a blank email to
framers-unsubscr...@lists.frameusers.com
or visit 
http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com

Send administrative questions to listad...@frameusers.com. Visit
http://www.frameusers.com/ for more resources and info.

Re: Engineers as authors

[Robert Lauriston]

Nice to hear you're not going to make that common mistake.

Supposedly you can lock down Word templates these days to restrict
styles to a defined list. I'll believe it when I see it.


On Wed, Oct 16, 2013 at 11:00 AM, Stephen O'Brien
 wrote:
>
> Your answers actually helped me nudge an existing project in a different 
> direction. The engineers were being asked a level of writing that was beyond 
> their abilities and a negative attitude was developing with regards to 
> contributing expert content.
___


You are currently subscribed to framers as arch...@mail-archive.com.

Send list messages to framers@lists.frameusers.com.

To unsubscribe send a blank email to
framers-unsubscr...@lists.frameusers.com
or visit 
http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com

Send administrative questions to listad...@frameusers.com. Visit
http://www.frameusers.com/ for more resources and info.

RE: Engineers as authors

[Michael Norton]

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


___


You are currently subscribed to framers as arch...@mail-archive.com.

Send list messages to framers@lists.frameusers.com.

To unsubscribe send a blank email to
framers-unsubscr...@lists.frameusers.com
or visit 
http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com

Send administrative questions to listad...@frameusers.com. Visit
http://www.frameusers.com/ for more resources and info.

Re: Engineers as authors

[Simon North]

Letting the engineers write within guidelines works for me. I am the sole
technical writer in the company. I also installed and manage two wikis -
one is a mirror image of suitable parts of the internal one containing
material suitable for the outside world.

Simon North


On Mon, Oct 7, 2013 at 6:41 PM, Robert Lauriston wrote:

> That's a proven approach. If you're going to do that, you should look
> into using a wiki.
>
>
> On Mon, Oct 7, 2013 at 7:26 AM, Stephen O'Brien 
> wrote:
> >
> >Or, maybe the role of the engineers should be to write rough content
> within guidelines (get the ideas and workflows on paper), and my team of
> technical writers could be responsible for formatting the content and
> expressing their ideas/workflows correctly in English. This would take much
> less time for the engineer (less of a learning curve).
> ___
>
>
> You are currently subscribed to framers as simon...@gmail.com.
>
> Send list messages to framers@lists.frameusers.com.
>
> To unsubscribe send a blank email to
> framers-unsubscr...@lists.frameusers.com
> or visit
> http://lists.frameusers.com/mailman/options/framers/simonxml%40gmail.com
>
> Send administrative questions to listad...@frameusers.com. Visit
> http://www.frameusers.com/ for more resources and info.
>
___


You are currently subscribed to framers as arch...@mail-archive.com.

Send list messages to framers@lists.frameusers.com.

To unsubscribe send a blank email to
framers-unsubscr...@lists.frameusers.com
or visit 
http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com

Send administrative questions to listad...@frameusers.com. Visit
http://www.frameusers.com/ for more resources and info.

RE: Engineers as authors

[Ann Zdunczyk]

When I started as a technical writer for Western Electric in 1978 the
requirement was that you had to have a technical degree to be hired. My
degree was in Electrical Engineering Technology. This requirement did not
change for quite a few years. We received the product engineering info from
the Engineers at Bell Labs. We took this info and created Task Oriented
Practices, Users Manuals, Installation Manuals etc. The Engineers were our
Subject Matter Experts and they review was we wrote. I am not sure if they
would have been happy taking their time away from development to actually
write these documents. 

Ann Z

-Original Message-
From: framers-boun...@lists.frameusers.com
[mailto:framers-boun...@lists.frameusers.com] On Behalf Of Helen Borrie
Sent: Tuesday, October 08, 2013 7:43 PM
To: Frame Users
Subject: Re: Engineers as authors

At 03:26 a.m. 8/10/2013, Stephen O'Brien wrote:

>Hi,
> 
>A few mechanical engineers have been asked, as part of their varied
workload, to author certain documents in English (How To, Webinars, software
essentials) in the near future.
> 
>Working with authors who are not formally trained is a new experience for
me. I am wondering how to best define their tasks and the tasks of my
technical writing group who will work together to ensure quality documents.
For example:
> 
>. I could provide the engineers with templates in FrameMaker and an
introduction to the basics of technical writing and English grammar and
bring them to write good documents over time. Some formal training in
technical writing could be offered. The technical writers would then review
the final documents (container and content) to ensure the overall quality of
the documents.
> 
>. Or, maybe the role of the engineers should be to write rough
content within guidelines (get the ideas and workflows on paper), and my
team of technical writers could be responsible for formatting the content
and expressing their ideas/workflows correctly in English. This would take
much less time for the engineer (less of a learning curve).
> 
>Do you have some experience in this matter? Any hints for what may work
best?

Is your task to train them to be tech writers or to be good informants?  Are
you tasked with producing the documentation or just with editing it? The
differences are crucial.  If they had meant to be tech writers, they
wouldn't (usually) have ended up as mechanical engineers.  And that's
discounting the built-in problem you possibly have there in Quebec, where
numbers of the engineers may not have learnt their composition skills in
English

Remember that old adage: "Don't keep a dog and bark yourself."  What sense
would it make to hire a team of tech writers and then make the engineers
produce near-final content?

My best advice is to CONSULT THE ENGINEERS.  Between you, you have to
establish the reader audience and what needs to be got - from whom and by
whom -  in order to produce each of the docs.  That needs Q & A on both
sides, both initial and ongoing  The "how" will follow on once the basics
are clear.

The engineers will have their own distinct preferences as to the tool they
would use to deliver content to you.  In my experience, engineers often
don't "get" word processors and just use them like a text editor.  Making
them use Word templates is unreasonable for them.  Many prefer to use simple
text editors or email.  You can put them in the way of using a freely
available text editor like MS Notepad or free Notepad++ and offer elementary
training to those who want it.  

Give them plain-text templates with headings and blocks that cover the
information you've all agreed you need.  They can use those to build topic
outlines and, subsequently, to fill up with content.  On your side, you can
build your formal document outlines in Frame and "stuff them as you go".
The engineers are likely to be interested in the outlines of
sections/chapters/volumes for which they, individually, will provide
content.  Those may or may not be congruent with the organisation of the
published docs, so making and maintaining road maps may be a task for you
and your team.  A lot depends on the intended audience, change management
and other stuff they might not be involved in directly.

One place where you will need more source tool consistency is in figures,
especially if the company uses one main CAD tool.  Your tech writers will
need a tool for converting CAD output to Frame-friendly images if the
software itself doesn't provide one.

Helen

___


You are currently subscribed to framers as azdunc...@triad.rr.com.

Send list messages to framers@lists.frameusers.com.

To unsubscribe send a blank email to
framers-unsubscr...@lists.frameusers.com
or visit
http://lists.frameusers.com/mailman/options/framers/azdunczyk%40triad.rr.com

Send ad

Re: Engineers as authors

[Helen Borrie]

At 03:26 a.m. 8/10/2013, Stephen O'Brien wrote:

>Hi,
> 
>A few mechanical engineers have been asked, as part of their varied workload, 
>to author certain documents in English (How To, Webinars, software essentials) 
>in the near future.
> 
>Working with authors who are not formally trained is a new experience for me. 
>I am wondering how to best define their tasks and the tasks of my technical 
>writing group who will work together to ensure quality documents. For example:
> 
>· I could provide the engineers with templates in FrameMaker and an 
>introduction to the basics of technical writing and English grammar and bring 
>them to write good documents over time. Some formal training in technical 
>writing could be offered. The technical writers would then review the final 
>documents (container and content) to ensure the overall quality of the 
>documents.
> 
>· Or, maybe the role of the engineers should be to write rough content 
>within guidelines (get the ideas and workflows on paper), and my team of 
>technical writers could be responsible for formatting the content and 
>expressing their ideas/workflows correctly in English. This would take much 
>less time for the engineer (less of a learning curve).
> 
>Do you have some experience in this matter? Any hints for what may work best?

Is your task to train them to be tech writers or to be good informants?  Are 
you tasked with producing the documentation or just with editing it? The 
differences are crucial.  If they had meant to be tech writers, they wouldn't 
(usually) have ended up as mechanical engineers.  And that's discounting the 
built-in problem you possibly have there in Quebec, where numbers of the 
engineers may not have learnt their composition skills in English

Remember that old adage: "Don't keep a dog and bark yourself."  What sense 
would it make to hire a team of tech writers and then make the engineers 
produce near-final content?

My best advice is to CONSULT THE ENGINEERS.  Between you, you have to establish 
the reader audience and what needs to be got - from whom and by whom -  in 
order to produce each of the docs.  That needs Q & A on both sides, both 
initial and ongoing  The "how" will follow on once the basics are clear.

The engineers will have their own distinct preferences as to the tool they 
would use to deliver content to you.  In my experience, engineers often don't 
"get" word processors and just use them like a text editor.  Making them use 
Word templates is unreasonable for them.  Many prefer to use simple text 
editors or email.  You can put them in the way of using a freely available text 
editor like MS Notepad or free Notepad++ and offer elementary training to those 
who want it.  

Give them plain-text templates with headings and blocks that cover the 
information you've all agreed you need.  They can use those to build topic 
outlines and, subsequently, to fill up with content.  On your side, you can 
build your formal document outlines in Frame and "stuff them as you go".  The 
engineers are likely to be interested in the outlines of 
sections/chapters/volumes for which they, individually, will provide content.  
Those may or may not be congruent with the organisation of the published docs, 
so making and maintaining road maps may be a task for you and your team.  A lot 
depends on the intended audience, change management and other stuff they might 
not be involved in directly.

One place where you will need more source tool consistency is in figures, 
especially if the company uses one main CAD tool.  Your tech writers will need 
a tool for converting CAD output to Frame-friendly images if the software 
itself doesn't provide one.

Helen

___


You are currently subscribed to framers as arch...@mail-archive.com.

Send list messages to framers@lists.frameusers.com.

To unsubscribe send a blank email to
framers-unsubscr...@lists.frameusers.com
or visit 
http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com

Send administrative questions to listad...@frameusers.com. Visit
http://www.frameusers.com/ for more resources and info.

Re: Engineers as authors

[Emily]

To begin with, if at all possible, I'd recommend you give each engineer
you will be working with an outline of each document you'd like
written.  The outline should include:
1.  Description of the target reader.
2.  General description of the document.
3.  List of topics/subtopics in outline form if at all
possible.
Offer to interview them to get them started.  And/or if you need to,
interview them to create this outline (that is, if you are not sure what
the document should be like, interview them to get an understanding from
them about what they think needs to be written.)
In my experience, engineers usually intend to write helpful
documentation, but due to time constraints, motivation or lack thereof,
and innate pedagogical talent, their ability to write useful stuff varies
widely.  I would try to provide people with a structure, praise
hugely for any results at all, be grateful for the good stuff, try to
make the not-so-good stuff better and run it back past the authors for
review in a non-judgmental way so they can see the changes you had to
make.
Getting engineers to help write documentation is likely to get you more
accurate documentation, but it will take time on your and on their
parts.  Usually, for me, it does not save me time, so much as
ensures the content is correct and correctly targeted for
readers.
Have fun.
- Emily
At 07:26 AM 10/7/2013, you wrote:
Content-Language: fr-FR
Content-Type: multipart/related;

boundary="_008_a5dc5afdd2de45499d86573fe295a2cdBLUPR04MB499namprd04pro_";

type="multipart/alternative"
Hi,
 
A few mechanical engineers have been asked, as part of their varied
workload, to author certain documents in English (How To, Webinars,
software essentials) in the near future.
 
Working with authors who are not formally trained is a new experience for
me. I am wondering how to best define their tasks and the tasks of my
technical writing group who will work together to ensure quality
documents. For example:
 
· I could provide the
engineers with templates in FrameMaker and an introduction to the basics
of technical writing and English grammar and bring them to write good
documents over time. Some formal training in technical writing could be
offered. The technical writers would then review the final documents
(container and content) to ensure the overall quality of the
documents.
 
· Or, maybe the role of
the engineers should be to write rough content within guidelines (get the
ideas and workflows on paper), and my team of technical writers could be
responsible for formatting the content and expressing their
ideas/workflows correctly in English. This would take much less time for
the engineer (less of a learning curve).
 
Do you have some experience in this matter? Any hints for what may work
best?
 
Many thanks. 
 
Here in Quebec City, Canada autumn is in full color. Mother Nature at her
very best.
 
 
Stephen O'BRIEN
Coordonnateur à la documentation et rédacteur technique senior |
Documentation Coordinator and Senior Technical Writer
InnovMetric Logiciels | Software
sobr...@innovmetric.com
T (1) 418.688.2061
F (1) 418.688.3001


 


 


 


 



AVIS DE CONFIDENTIALITÉ/CONFIDENTIALITY NOTICE: Ce message peut contenir
des renseignements confidentiels appartenant exclusivement à InnovMetric
Logiciels inc. ou à ses filiales. Si vous n’êtes pas le destinataire
indiqué dans ce message (ou responsable de livrer ce message à la
personne indiquée ou prévue) ou si vous pensez que ce message vous a été
adressé par erreur, vous ne pouvez pas utiliser ou reproduire ce message,
ni le livrer à quelqu’un d’autre. Dans ce cas, veuillez le retourner à
l’expéditeur et le détruire. Proprietary confidential information
belonging to InnovMetric Software Inc. and its affiliates may be
contained in this message. If you are not a recipient indicated or
intended in this message (or responsible for delivering this message to
such a person), or you think for any reason that this message may have
been addressed to you by mistake, you may not use or copy this message,
or deliver it to anyone else. In which case, notify the sender and
destroy the e-mail.
 

___

You are currently subscribed to framers as
em...@armadillosoft.com.
Send list messages to framers@lists.frameusers.com.
To unsubscribe send a blank email to
framers-unsubscr...@lists.frameusers.com
or visit

http://lists.frameusers.com/mailman/options/framers/emily%40armadillosoft.com

Send administrative questions to listad...@frameusers.com. Visit

http://www.frameusers.com/ for more resources and
info.

___


You are currently subscribed to framers as arch...@mail-archive.com.

Send list messages to framers@lists.frameusers.com.

To unsubscribe send a blank email to
framers-unsubscr...@lists.frameusers.com
or visit 
http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com

Send administrative questions t

Re: Engineers as authors

[a...@ant-davey.com]

 
  
   Working with railway engineers in the UK, I'd have to agree with Matt.
   
  
    
   
  
   Your biggest challenge is going to get the engineers to adopt brevity, or minimalism as we sometimes call it.
   
  
    
   
  
   You will need to define a level of assumed knowledge in your audiences, and then determine the questions that need answers.  The herding cats bit will come when you try to get the engineers to write something that ONLY answers the question in front of them.
   
  
    
   
  
   Yes, let them write in Word, but develop a template in which the paragraph format names are exactly the same as those in Frame. Content then imports by copy with little additional work needed. (You will need to delete the Word markup for ordered and unordered lists.  The hard part here will be getting the engineers to use the paragraph formats and not inline formatting.
   
  
    
   
  
   Good luck,
   
  
   Ant
   
  
   On 07 October 2013 at 16:25 Matt Sullivan  wrote:
   
   Training engineers in tech comm tools is usually about as effective as training tech comms in the software tools the engineers use--that is, it's not generally effective. 
   
 

   
I recommend the engineers use whatever tool they're most comfortable with (Word) and you provide a template and train them in use of stylesheets and standards in that application.

   
 

   
After the content is written, have your team import it into Fm.

   
 

   
For changes, give the engineers a PDF and use Fm's commenting and revision tools to update content.

   
 

   
FWIW, this it the way I handle docs for a major corporate airline and a large medical software company.
 
 
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
 -Matt 
 
  Matt R. Sullivan 
  co-author Publishing Fundamentals: Unstructured FrameMaker 11 P: 714.798.7596 | C: 714.585.2335 | m...@mattrsullivan.com @mattrsullivan LinkedIn facebook mattrsullivan.com  
  
 
 
 
 
  On Oct 7, 2013, at 7:26 AM, Stephen O'Brien <
  sobr...@innovmetric.com> wrote:
  
  
  
   


 Hi,
 

  
 

 A few mechanical engineers have been asked, as part of their varied workload, to author certain documents in English (How To, Webinars, software essentials) in the near future.
 

  
 

 Working with authors who are not formally trained is a new experience for me. I am wondering how to best define their tasks and the tasks of my technical writing group who will work together to ensure quality documents. For example:
 

  
 

 · I could provide the engineers with templates in FrameMaker and an introduction to the basics of technical writing and English grammar and bring them to write good documents over time. Some formal training in technical writing could be offered. The technical writers would then review the final documents (container and content) to ensure the overall quality of the documents.
 

  
 

 · Or, maybe the role of the engineers should be to write rough content within guidelines (get the ideas and workflows on paper), and my team of technical writers could be responsible for formatting the content and expressing their ideas/workflows correctly in English. This would take much less time for the engineer (less of a learning curve).
 

  
 

 Do you have some experience in this matter? Any hints for what may work best?
 

  
 

 Many thanks.
 

  
 

 Here in Quebec City, Canada autumn is in full color. Mother Nature at her very best.
 

  
 

  
 
Stephen O'BRIENCoordonnateur à la documentation et rédacteur technique senior | Documentation Coordinator and Senior Technical WriterInnovMetric Logiciels | Softwaresobr...@innovmetric.comT (1) 418.688.2061F (1) 418.688.3001 
 
AVIS DE CONFIDENTIALITÉ/CONFIDENTIALITY NOTICE: Ce message peut contenir des renseignements confidentiels appartenant exclusivement à InnovMetric Logiciels inc. ou à ses filiales. Si vous n’êtes pas le destinataire indiqué dans ce message (ou responsable de livrer ce message à la personne indiquée ou prévue) ou si vous pensez que ce message vous a été adressé par erreur, vous ne pouvez pas utiliser ou reproduire ce message, ni le livrer à quelqu’un d’autre. Dans ce cas, veuillez le retourner à l’expéditeur et le détruire. Proprietary confidential information belonging to InnovMetric Software Inc. and its affiliates may 

Re: Engineers as authors

[Robert Lauriston]

That's a proven approach. If you're going to do that, you should look
into using a wiki.


On Mon, Oct 7, 2013 at 7:26 AM, Stephen O'Brien  wrote:
>
>Or, maybe the role of the engineers should be to write rough content 
> within guidelines (get the ideas and workflows on paper), and my team of 
> technical writers could be responsible for formatting the content and 
> expressing their ideas/workflows correctly in English. This would take much 
> less time for the engineer (less of a learning curve).
___


You are currently subscribed to framers as arch...@mail-archive.com.

Send list messages to framers@lists.frameusers.com.

To unsubscribe send a blank email to
framers-unsubscr...@lists.frameusers.com
or visit 
http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com

Send administrative questions to listad...@frameusers.com. Visit
http://www.frameusers.com/ for more resources and info.

Re: Engineers as authors

[John Sgammato]

IMO you'll have more success and happier times if you take the latter
route. They'll never need to know FrameMaker and may resent having to learn
it.
OTOH showing them some of the principles of tech writing shows them that
there is more to our profession than transcription and formatting. A lot of
"Here's what needs to be done - you do this easy part and we'll take care
of the rest" can simultaneously educate them and make them happy that they
don't have to handle everything form planning through authoring and review
to production and publication and archiving... and in the end you get more
respect as they understand all the work you do to make their words look
good.


On Mon, Oct 7, 2013 at 10:26 AM, Stephen O'Brien wrote:

>  Hi,
>
> ** **
>
> A few mechanical engineers have been asked, as part of their varied
> workload, to author certain documents in English (How To, Webinars,
> software essentials) in the near future.
>
> ** **
>
> Working with authors who are not formally trained is a new experience for
> me. I am wondering how to best define their tasks and the tasks of my
> technical writing group who will work together to ensure quality documents.
> For example:
>
> ** **
>
> **· **I could provide the engineers with templates in FrameMaker
> and an introduction to the basics of technical writing and English grammar
> and bring them to write good documents over time. Some formal training in
> technical writing could be offered. The technical writers would then review
> the final documents (container and content) to ensure the overall quality
> of the documents.
>
> ** **
>
> **· **Or, maybe the role of the engineers should be to write
> rough content within guidelines (get the ideas and workflows on paper), and
> my team of technical writers could be responsible for formatting the
> content and expressing their ideas/workflows correctly in English. This
> would take much less time for the engineer (less of a learning curve).
>
> ** **
>
> Do you have some experience in this matter? Any hints for what may work
> best?
>
> ** **
>
> Many thanks. 
>
> ** **
>
> Here in Quebec City, Canada autumn is in full color. Mother Nature at her
> very best.
>
> ** **
>
> ** **
>
> *Stephen O'BRIEN*
> Coordonnateur à la documentation et rédacteur technique senior |
> Documentation Coordinator and Senior Technical Writer
> InnovMetric Logiciels | Software
> sobr...@innovmetric.com
> *T *(1) 418.688.2061
> *F *(1) 418.688.3001
>
>     
> 
>  
> 
> 
>
> AVIS DE CONFIDENTIALITÉ/CONFIDENTIALITY NOTICE: Ce message peut contenir
> des renseignements confidentiels appartenant exclusivement à InnovMetric
> Logiciels inc. ou à ses filiales. Si vous n’êtes pas le destinataire
> indiqué dans ce message (ou responsable de livrer ce message à la personne
> indiquée ou prévue) ou si vous pensez que ce message vous a été adressé par
> erreur, vous ne pouvez pas utiliser ou reproduire ce message, ni le livrer
> à quelqu’un d’autre. Dans ce cas, veuillez le retourner à l’expéditeur et
> le détruire. Proprietary confidential information belonging to
> InnovMetric Software Inc. and its affiliates may be contained in this
> message. If you are not a recipient indicated or intended in this message
> (or responsible for delivering this message to such a person), or you think
> for any reason that this message may have been addressed to you by mistake,
> you may not use or copy this message, or deliver it to anyone else. In
> which case, notify the sender and destroy the e-mail.
>
> ** **
>
> ___
>
>
> You are currently subscribed to framers as john.sgamm...@actifio.com.
>
> Send list messages to framers@lists.frameusers.com.
>
> To unsubscribe send a blank email to
> framers-unsubscr...@lists.frameusers.com
> or visit
> http://lists.frameusers.com/mailman/options/framers/john.sgammato%40actifio.com
>
> Send administrative questions to listad...@frameusers.com. Visit
> http://www.frameusers.com/ for more resources and info.
>
>


-- 

*John Sgammato, Documentation Architect*
*e* john.sgamm...@actifio.com  *c* 508.927.2083
*t* @actifiodocs 

333 Wyman Street, Waltham, MA 02451



  

*Radically simple copy data management *

*.**
*
<><><><><>___


You are currently subscribed to framers as arch...@mail-archive.com.

Send list messages to framers@lists.frameusers.com.

To unsubscribe send a blank email to
framers-unsubscr...@lists.frameusers.com
or visit 
ht

Re: Engineers as authors

[Chris Despopoulos]

I think the first step is to determine the value proposition of the product.  
Then determine how much of that value must come from the engineers, and how 
much your group can provide.  From there the responsibilities should shake out 
on their own.  This may be a negotiation, but I think it's the first thing to 
do.  If the value of the product is clear to the engineers, they're more likely 
to contribute.  If you clarify what of that value is beyond your group's 
capability, they will have a clear idea of what they must provide.  If you 
clarify what your group will provide, then they will see you as adding value.

I would not deliver writing classes until you have taken care of the above.  
Just my opinion...___


You are currently subscribed to framers as arch...@mail-archive.com.

Send list messages to framers@lists.frameusers.com.

To unsubscribe send a blank email to
framers-unsubscr...@lists.frameusers.com
or visit 
http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com

Send administrative questions to listad...@frameusers.com. Visit
http://www.frameusers.com/ for more resources and info.

RE: Engineers as authors

[Stephen O'Brien]

Excellent question.

It is my experience that writing obliges one to structure one's thought and 
make clear concepts that otherwise, expressed orally, are presented more 
vaguely.

This is certainly a benefit, as is good, solid procedural documentation.

There is the general question as to whether tech writers or engineers should be 
doing the work of documentation creation.

To answer your question, it is seen as more work at this initial stage.

Stephen O'BRIEN
Coordonnateur à la documentation et rédacteur technique senior | Documentation 
Coordinator and Senior Technical Writer
T (1) 418.688.2061

-Message d'origine-
De : Milan Davidović [mailto:milan.li...@gmail.com] 
Envoyé : Monday, October 07, 2013 12:45 PM
À : Stephen O'Brien
Cc : Frame Users (framers@lists.frameusers.com)
Objet : Re: Engineers as authors

It looks as though the documentation they create has the potential to reduce 
the time they spend on those tasks. Aside from being "open" to the new 
responsibilities, do they see how it benefits them? Or do they simply see more 
work?

--Milan Davidović

Sent from my Yost 10


On Mon, Oct 7, 2013 at 11:40 AM, Stephen O'Brien  
wrote:
> They are wondering what their exact responsibilities will be. They 
> have many other tasks (training, solving client problems over the phone or 
> on-site).
> They are open to contributing content but at the same time have 
> questions about the time that can take.
___


You are currently subscribed to framers as arch...@mail-archive.com.

Send list messages to framers@lists.frameusers.com.

To unsubscribe send a blank email to
framers-unsubscr...@lists.frameusers.com
or visit 
http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com

Send administrative questions to listad...@frameusers.com. Visit
http://www.frameusers.com/ for more resources and info.

Re: Engineers as authors

[Milan Davidović]

It looks as though the documentation they create has the potential to
reduce the time they spend on those tasks. Aside from being "open" to
the new responsibilities, do they see how it benefits them? Or do they
simply see more work?

--Milan Davidović

Sent from my Yost 10


On Mon, Oct 7, 2013 at 11:40 AM, Stephen O'Brien
 wrote:
> They are wondering what their exact responsibilities will be. They have many
> other tasks (training, solving client problems over the phone or on-site).
> They are open to contributing content but at the same time have questions
> about the time that can take.
___


You are currently subscribed to framers as arch...@mail-archive.com.

Send list messages to framers@lists.frameusers.com.

To unsubscribe send a blank email to
framers-unsubscr...@lists.frameusers.com
or visit 
http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com

Send administrative questions to listad...@frameusers.com. Visit
http://www.frameusers.com/ for more resources and info.

RE: Engineers as authors

[Stephen O'Brien]

Hi,

Creating quality client-oriented documentation within a process managed by 
technical writers is new for them.

They are wondering what their exact responsibilities will be. They have many 
other tasks (training, solving client problems over the phone or on-site). They 
are open to contributing content but at the same time have questions about the 
time that can take.

Stephen O'BRIEN
Coordonnateur à la documentation et rédacteur technique senior | Documentation 
Coordinator and Senior Technical Writer
T (1) 418.688.2061

De : Milan Davidović [mailto:milan.li...@gmail.com]
Envoyé : Monday, October 07, 2013 11:07 AM
À : Stephen O'Brien
Cc : Frame Users (framers@lists.frameusers.com)
Objet : Re: Engineers as authors

How are the engineers responding to this?
--Milan Davidović

Sent from my Yost 10

On Mon, Oct 7, 2013 at 10:26 AM, Stephen O'Brien 
mailto:sobr...@innovmetric.com>> wrote:
A few mechanical engineers have been asked, as part of their varied workload, 
to author certain documents in English (How To, Webinars, software essentials) 
in the near future.
___


You are currently subscribed to framers as arch...@mail-archive.com.

Send list messages to framers@lists.frameusers.com.

To unsubscribe send a blank email to
framers-unsubscr...@lists.frameusers.com
or visit 
http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com

Send administrative questions to listad...@frameusers.com. Visit
http://www.frameusers.com/ for more resources and info.

Re: Engineers as authors

[Matt Sullivan]

Training engineers in tech comm tools is usually about as effective as training tech comms in the software tools the engineers use--that is, it's not generally effective.I recommend the engineers use whatever tool they're most comfortable with (Word) and you provide a template and train them in use of stylesheets and standards in that application.After the content is written, have your team import it into Fm.For changes, give the engineers a PDF and use Fm's commenting and revision tools to update content.FWIW, this it the way I handle docs for a major corporate airline and a large medical software company.
-MattMatt R. Sullivan co-author Publishing Fundamentals: Unstructured FrameMaker 11 P: 714.798.7596 | C: 714.585.2335 | m...@mattrsullivan.com @mattrsullivan LinkedIn facebook mattrsullivan.com 

On Oct 7, 2013, at 7:26 AM, Stephen O'Brien  wrote:Hi, A few mechanical engineers have been asked, as part of their varied workload, to author certain documents in English (How To, Webinars, software essentials) in the near future. Working with authors who are not formally trained is a new experience for me. I am wondering how to best define their tasks and the tasks of my technical writing group who will work together to ensure quality documents. For example: · I could provide the engineers with templates in FrameMaker and an introduction to the basics of technical writing and English grammar and bring them to write good documents over time. Some formal training in technical writing could be offered. The technical writers would then review the final documents (container and content) to ensure the overall quality of the documents. · Or, maybe the role of the engineers should be to write rough content within guidelines (get the ideas and workflows on paper), and my team of technical writers could be responsible for formatting the content and expressing their ideas/workflows correctly in English. This would take much less time for the engineer (less of a learning curve). Do you have some experience in this matter? Any hints for what may work best? Many thanks. Here in Quebec City, Canada autumn is in full color. Mother Nature at her very best.  Stephen O'BRIENCoordonnateur à la documentation et rédacteur technique senior | Documentation Coordinator and Senior Technical WriterInnovMetric Logiciels | Softwaresobr...@innovmetric.comT (1) 418.688.2061F (1) 418.688.3001AVIS DE CONFIDENTIALITÉ/CONFIDENTIALITY NOTICE: Ce message peut contenir des renseignements confidentiels appartenant exclusivement à InnovMetric Logiciels inc. ou à ses filiales. Si vous n’êtes pas le destinataire indiqué dans ce message (ou responsable de livrer ce message à la personne indiquée ou prévue) ou si vous pensez que ce message vous a été adressé par erreur, vous ne pouvez pas utiliser ou reproduire ce message, ni le livrer à quelqu’un d’autre. Dans ce cas, veuillez le retourner à l’expéditeur et le détruire. Proprietary confidential information belonging to InnovMetric Software Inc. and its affiliates may be contained in this message. If you are not a recipient indicated or intended in this message (or responsible for delivering this message to such a person), or you think for any reason that this message may have been addressed to you by mistake, you may not use or copy this message, or deliver it to anyone else. In which case, notify the sender and destroy the e-mail. ___You are currently subscribed to framers as m...@mattrsullivan.com.Send list messages to framers@lists.frameusers.com.To unsubscribe send a blank email toframers-unsubscr...@lists.frameusers.comor visit http://lists.frameusers.com/mailman/options/framers/matt%40mattrsullivan.comSend administrative questions to listad...@frameusers.com. Visithttp://www.frameusers.com/ for more resources and info.___


You are currently subscribed to framers as arch...@mail-archive.com.

Send list messages to framers@lists.frameusers.com.

To unsubscribe send a blank email to
framers-unsubscr...@lists.frameusers.com
or visit 
http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com

Send administrative questions to listad...@frameusers.com. Visit
http://www.frameusers.com/ for more resources and info.

Re: Engineers as authors

[Milan Davidović]

How are the engineers responding to this?
 --Milan Davidović

Sent from my Yost 10


On Mon, Oct 7, 2013 at 10:26 AM, Stephen O'Brien wrote:

>  A few mechanical engineers have been asked, as part of their varied
> workload, to author certain documents in English (How To, Webinars,
> software essentials) in the near future.
>
___


You are currently subscribed to framers as arch...@mail-archive.com.

Send list messages to framers@lists.frameusers.com.

To unsubscribe send a blank email to
framers-unsubscr...@lists.frameusers.com
or visit 
http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com

Send administrative questions to listad...@frameusers.com. Visit
http://www.frameusers.com/ for more resources and info.