Documentation

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 documents are used to provide additional documentation, know how, guidelines and examples to understand the background of a specific topic

The operating manual contains all necessary information and tasks to operate and manage a product or object. For software products, the operating manual is mostly relevant for IT operations to install, integrate, manage and upgrade the product.

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

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.

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.