Documentation

Software documentation is different because it serves a dual purpose.

Users refer to developer documentation when implementing software in their organisation and developers use documentation to record the software development process.

Installation

The installation guide describes how a specific product or software application needs to be installed. Include any prerequisites, system requirements, configuration options and pre-install maintenance steps.

Introduction

Your content here

Operating Manual

Your content here

Product Features

The product feature documentation covers the main features and modules. The included template can be easily adapted for core each feature within the product.

Reference

A reference document describes specific terms and phrases used by a product and included in the documentation. When referring to a fact or statistic include a citation to the original source.

Troubleshooting

A troubleshooting guide helps the user with a specific problem or issue with the software, to solve or perform a workaround. This includes a description the problem, the cause including typical use case to repeat the problem, a description of the solution including step-by-step instructions and lastly references to related documentation in a knowledge base, user, product or operating manual.