Re: Annotated outlines...

Subject: Re: Annotated outlines...
From: Sarah Lee Hauslinger <slhauslinger -at- gmail -dot- com>
To: "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Sun, 9 Oct 2011 12:53:09 -0700

Yup, I've used this exact same technique to help nonwriters (engineers,
analysts, sysadmins, et al.) generate clear and focused documents. It's
worked beautifully.

A couple of caveats: I've seen them get confused by the term "template"
(they ask for a .dot file). They've also been resistant to the term
"outline" (they get huffy at the least suggestion that they can't write,
heheheh).

So, instead, I call it a "document specification". They get what that means,
follow the spec without significant crankiness, and the end result is pretty
darn good.


HTH,
Sarah Lee


On Sun, Oct 9, 2011 at 1:41 AM, Sue Jones <suej_be -at- yahoo -dot- com> wrote:

> I have also used the annotated outline method with great success. It's
> definitely worth a try.
>
> Not long ago I developed a series of project management templates (project
> plan, specifications, testing and quality docs), for some Dutch project
> managers writing in US Englsh. Each section stated whether it was mandatory
> or optional and then had a brief description of the type of information it
> should contain. The templates worked really well for them.
> I left the company about three years ago after almost 10 years as a
> contractor with them and they are still using the templates. Always a good
> sign.
>
> I use the same technique when writing training courses that will be
> delivered by anyone other than myself. There again, the approach works a
> treat.
>
> Gr.
> Sue.
>
> "To achieve greatness...start where you are, use what you have, do what you
> can." Arthur Ashe.
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> Create and publish documentation through multiple channels with
> Doc-To-Help.
> Choose your authoring formats and get any output you may need. Try
> Doc-To-Help, now with MS SharePoint integration, free for 30-days.
> http://www.doctohelp.com
>
> ---
> You are currently subscribed to TECHWR-L as slhauslinger -at- gmail -dot- com -dot-
>
> To unsubscribe send a blank email to
> techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
> or visit
> http://lists.techwr-l.com/mailman/options/techwr-l/slhauslinger%40gmail.com
>
>
> To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com
>
> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
> http://www.techwr-l.com/ for more resources and info.
>
> Please move off-topic discussions to the Chat list, at:
> http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat
>
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days.
http://www.doctohelp.com

---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


Follow-Ups:

References:
Annotated outlines...: From: Sue Jones

Previous by Author: Re: ISO Document Control
Next by Author: Re: How long and what effort for Microsoft to move help
Previous by Thread: RE: Annotated outlines...
Next by Thread: Re: Annotated outlines...


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


Sponsored Ads