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.
-----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
