InstallationLast updated: 07/02/2023
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.
2.1 Installation
Include product information, purpose of the document, release/version of the software to be installed. In all cases the documentation should clearly state the version and release date of the software and similarly the version and publication date of the documents.
2.2 Pre-installation requirements
Define the specification of the hardware and software that is required (e.g. operating system and the minimal version, database, web server, application server, libraries, additional software); of possible, provide a checklist for the administrator.
2.3 Installation instructions
Step-by-step instructions with screenshots, or exact command line calls with all parameters. Use the code editor to insert command line syntax which can be easily copied and pasted by the user.
2.4 Configuration settings
Describe file type and file paths of any configuration files and settings, and the expected changes/output by the user. Where existing files are modified has an example of pre-and post installation. This should be across all platforms supported by the software.
2.5 Post-installation tasks and checklist
Provide examples of any cleanup routine, removal of redundant files and the cleanup and verification steps required. Does your software overwrite the existing or do you install alongside an existing version requiring removal as a post installation task.
2.6 Troubleshooting
Provide examples and typical questions regarding any problems that might occur during the installation. Typically this could involve permissions issues for users, questions relating to existing data and how to restore previous state in the event of a problem.
2.7 Further reading
In relation to the troubleshooting section provide references to additional guides, explanation documents and resources in the product documentation, or external references. For example if you have I known permissions problem with a known answer which is available on Stack Overflow you could provide a URL to reference relevant documentation and solution.