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.
Subject:Re: TECHWR-L Digest - 27 Jan 1999 to 28 Jan 1999 From:John Wilson <jwilson -at- AMADEUS -dot- NET> Date:Fri, 29 Jan 1999 10:16:16 +0100
Does anyone have an outline for a software installation guide? I mean a
logical outline (effectively a contents list) which provides a consistent
structure for guides about different products, not an actual file.
Something like this:
1. Before Installation
1.1 Overview of files and installation options
1.2 Getting a copy of the kit
1.3 Prerequisite hardware
1.4 Prerequisite software
2. Installation
2.1 Types of installation possible
2.2 Installing the software
3 After installation
3.1 Setting up parameters etc
3.2 Testing the installation
3.3 Configuring ...
Appendix A: Locations of files
Appendix B: Log file
This is from memory, just as an example of the sort of thing I am looking
for, so excuse lack of parallelism etc. I would be interested in seeing
other versions as I am trying to develop such an outline here.
Also if anyone has templates for any other software (user or system)
documents I would like to see them. Installations do not vary much within a
platform, so lend themselves to this sort of approach. It may be that specs
and user guides are too variable to have a generally applicable outline,
but even generic chapter or "super-chapter" titles would be useful, e.g.
for a user guide:
Overview
What this product is
What it does
How it relates to other products
