FW: Configuration Guides

Subject: FW: 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: Tue, 8 Mar 2016 14:57:01 +0000

Hi All,

I wanted to update you on what I decided to do. Since this is a project where we purchased software and the mandate is to use it out of the box as much as possible, the documentation is slightly different than normal. In this case, configuration means that we add our own information like drop-down lists, add industry standards, make some requests for enhancements, try to fit the software into how our engineers do projects, and change processes where necessary.

So, with all of that in mind and considering that things change, I decided to add the bulleted information below to the document as well as an overview of change management. People need to know how to make changes to our configured environment and we need an historical (hysterical?) record of what was configured. Executive decision by a decidedly non-executive person.

Ginger Shew-Stuckey
Technical Writer - Design

From: Stuckey, Ginger
Sent: Thursday, March 03, 2016 12:48 PM
To: TechWR-L (techwr-l -at- lists -dot- techwr-l -dot- com)
Subject: Configuration Guides

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


References:
Configuration Guides: From: Stuckey, Ginger

Previous by Author: RE: Configuration Guides
Next by Author: Software Training: Video only -v- Blended
Previous by Thread: RE: Configuration Guides
Next by Thread: Current industry standards for Process Flows


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

Sponsored Ads


Sponsored Ads