Configuration Guides

Subject: Configuration Guides
From: "Stuckey, Ginger" <X2BVSHEW -at- SOUTHERNCO -dot- COM>
To: "TechWR-L (techwr-l -at- lists -dot- techwr-l -dot- com)" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 3 Mar 2016 18:47:34 +0000

Hi All,

The company I work for is going through a huge software change. After much noise-making, the tech writers are involved in all training, requirements gather, and configuration sessions. For various reasons, we are not sure what kind of we will create. One thing we do know is the project manager absolutely needs configuration guides because there is some customization required. Installation guides are separate so this is only configuration.
The following list is what I think should go into the guide, not including scope and stuff like that.

* Description of configured item.

* Affected databases.

* How to configure the item. (Even if it is in an Admin module?)

* List of configured data or link to a document if the list is long.

Should configuration change management be included?
What am I leaving out of this document?

Ginger Stuckey
Technical Writer - Design

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.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-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: Batch conversion of PDF to Word
Next by Author: RE: Configuration Guides
Previous by Thread: Re: Word improves numbered list management
Next by Thread: Re: Configuration Guides


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

Sponsored Ads


Sponsored Ads