I have just finished development of my first java application and need to write some basic user documentation to inform the end user on how to do things such as run, configure, and troubleshoot error messages with the application.
Are there any standard sections that I should include in this document? ideally I would like to find a Microsoft Word template to start off with, but any advice would be appreciated.
Currently, it will be deployed copying it to a Windows application server and run using an Enterprise Scheduling application. In general, the only thing that will need to be changed after implementation will be the configuration file ( read in by the Java properties class ).
However, I want to ensure that whoever uses the application after I am long gone ( to a better job, of course! ) will understand how it works, and be able to support it. Hence the documentation.
Btw, The api is covered by Javadoc html documentation, so I just need to create a User manual to explain its usage and support.
