A good way to break down your documentation is into sections that logical fit the flow of installing and running your application. Here at CenturyLink, we like to use the following sections as our boilerplate and then work them from there.
-
Application Name: Describe your application and its services (if any) here.
-
System Requirements: Define minimum system requirements to successfully run the application. For Example: Recommended 2 Cores, 2GB of RAM
-
Setup: Provide instructions on how to setup the application.
-
Post-Run Instructions: Provide users of this template with any steps needed to complete the configuration of the application.
-
Resources: List any other resources that you may want to share.