RE: Configuration Guides

Subject: RE: Configuration Guides
From: "Wroblewski, Victoria" <victoria -dot- wroblewski -at- necect -dot- com>
To: 'Ryan Young' <ryangyoung -at- gmail -dot- com>, Helen OBoyle <hoboyle -at- gmail -dot- com>
Date: Mon, 7 Mar 2016 23:00:30 +0000

-----Original Message-----
From: Ryan Young
Sent: Monday, March 7, 2016 4:16 PM
Subject: Re: Configuration Guides

We're also working on defining what each guide should be. The other tech writer here has pushed for combining installation, configuration, and common operator tasks into an "Operations" guide. I feel like that's a bad idea as it makes users effectively search through two irrelevant guides. It sounds like the consensus here would be to separate out those three topics?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

We have guides split into installation/configuration (which is more basic configuration), then different guides for features not everyone may use like security features, etc. Then it is on to the maintenance guide, and even a different guide for upgrades, so on. Our big argument for splitting them up was to not have one master guide that was thousands of pages long, and also to support IT groups installing and using our system that may have totally different people who are responsible for ONE aspect of it and don't care about anything else.

- V
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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
RE: Configuration Guides: From: Erika Yanovich
RE: Configuration Guides: From: Helen OBoyle
Re: Configuration Guides: From: Ryan Young

Previous by Author: Re: "Surviving the Dying Career of Technical Writing"
Next by Author: RE: Translation Software - pulling terms from software
Previous by Thread: Re: Configuration Guides
Next by Thread: RE: Configuration Guides


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

Sponsored Ads


Sponsored Ads