ReadySetGit/Words-of-Wisdom-Installation-and-Quick-Start.md

40 lines
1.6 KiB
Markdown
Raw Normal View History

2021-08-02 15:24:06 +00:00
# Install
2021-08-02 17:30:16 +00:00
## Line-by-line Instructions
### Release Number
2021-08-02 15:24:06 +00:00
Clearly identify the release that these instructions apply to. Otherwise, if users have multiple versions of your product, it is possible that they will confuse different versions of the installation document.
2021-08-02 17:30:16 +00:00
### Customer Support
2021-08-02 15:24:06 +00:00
Clearly indicate the user's technical support options.
2021-08-02 17:30:16 +00:00
### Introduction
2021-08-02 15:24:06 +00:00
Give a very brief description of this release.
2021-08-02 17:30:16 +00:00
### Minimal System Requirements
2021-08-02 15:24:06 +00:00
The minimal system requirements are stated in the release notes.
2021-08-02 17:30:16 +00:00
2021-08-02 15:24:06 +00:00
Customization: you may prefer to write the minimal system requirements into these installation instructions and remove it from the release notes.
2021-08-02 17:30:16 +00:00
### What other software must be installed first?
2021-08-02 15:24:06 +00:00
List prerequisite software that must be installed before your product can be installed.
2021-08-02 17:30:16 +00:00
### How do I install PRODUCT-NAME?
2021-08-02 15:24:06 +00:00
Write the installation steps here. The steps should be written in enough detail that an actual user can follow them. You must test the installation process with actual users before shipping the release. Users who have difficulty installing the product can generate expensive calls to technical support.
2021-08-02 17:30:16 +00:00
### How can I uninstall PRODUCT-NAME?
2021-08-02 15:24:06 +00:00
Likewise, write the uninstall steps in enough detail for a user to actually follow.
2021-08-02 17:30:16 +00:00
### Getting Started
2021-08-02 15:24:06 +00:00
It can be a good idea to show users how to perform a very simple tasks to prove to themselves that the product is properly installed and working. For example, the Apache webserver will show a default page that simply indicates that the server is up and working.
2021-08-02 17:30:16 +00:00
2021-08-02 15:24:06 +00:00
Customization: you may choose to simply refer to the getting started section of the userguide.