TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Users need to duplicate their working environments in the new tool?
I'd call that a migration guide.
On Thu, Mar 3, 2016 at 11:51 AM, Stuckey, Ginger
<X2BVSHEW -at- southernco -dot- com> wrote:
> Robert,
>
> First, thanks for taking time to review.
>
> My is not going through an upgrade but an change from one engineering software to a completely different software. It is something engineers and drafters use to create 3D models and 2D drawings (not AutoCAD). The software needs to be configured for the way the company works. Things like populating drop-down lists, adding engineering catalogs, piping specifications, and mapping current information to the new information.
>
> I'm just trying to think of everything that should go into a configuration guide.
>
> G.
>
> -----Original Message-----
> From: techwr-l-bounces+x2bvshew=southernco -dot- com -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+x2bvshew=southernco -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf Of Robert Lauriston
> Sent: Thursday, March 03, 2016 1:29 PM
> To: TECHWR-L Writing
> Subject: Re: Configuration Guides
>
> It's not clear to me what kind of project you're talking about. A
> major software upgrade? For a program or platform your company sells
> or something you use?
>
> On Thu, Mar 3, 2016 at 10:47 AM, Stuckey, Ginger
> <X2BVSHEW -at- southernco -dot- com> wrote:
>> 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?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.com
