Re: Subject: Re: Bloated Docs: Identifying What's Useful

Subject: Re: Subject: Re: Bloated Docs: Identifying What's Useful
From: Alison Wyld <ajwyld -at- gmail -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Mon, 27 Feb 2012 11:11:11 +0100

Just another thought for Doughty's project.

Don't try to do it all at once - make yourself some sort of incremental
improvement project plan and write it down. This will help preserve your
sanity (cause otherwise you'll go nuts trying to do everything all at
once.) Also it will be a good tool to help you explain to your management
what you are doing and how you are progressing. Finally, we all know that
no job is forever. You might get offered your dream job elsewhere before
you're done. Doing this will let your successor pick up where you left off.
It doesn't need to be complicated or involve much overhead. XL or something.

For example, I'm involved in a project with a big doc set that has evolved
over the last 10 years and has had a high turnover of staff. We now have a
strategy of rolling improvements, so every release, in addition to
necessary incremental updates, we pick one part of the set to overhaul and
rework. Last year it was the Operational Procedures, this year it was the
Compliance Statements. Working on the Compliance Statements made us realize
that the Developer Procedures could use some work - so we have written down
that this should be done next time. By that time, it will probably be time
to go back and look at the Operational stuff again... I'm sure you get the
picture.

cheers

Alison Wyld

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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://bit.ly/doc-to-help

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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-leave -at- lists -dot- techwr-l -dot- com


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

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


Follow-Ups:

Previous by Author: RE: Bloated Docs: Identifying What's Useful
Next by Author: AW: Software Style Guides
Previous by Thread: Re: Subject: Re: Bloated Docs: Identifying What's Useful
Next by Thread: Re: Bloated Docs: Identifying What's Useful


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

Sponsored Ads


Sponsored Ads