User_Guide_template

advertisement
User Guide: <standard script name>
TOC
Description
Installation
Pre-requisite
Parameters
Input dataset(s)
Input parameter(s)
Output
Example(s)
Example 1: <Example 1 title>
Example 2: <Example 2 title>
...
Limitation(s)
Change log
Description
What does the standard program do? What is the purpose?
Installation
What must be set or run in order to have the program working: sasauto/autoexec?
%include?.
Pre-requisite
In this section, pre-requisites in terms of software version, system version, etc. are listed.
Parameters
Input dataset(s)
In this section, the different input datasets are described with their requirements.
Input parameter(s)
In this section, each input parameter is described with type, a few sentences and an example.
If a parameter can take a limited number of values, they are listed here.
Parameter name
Type
Description and Example
Output
This section describes and specifies output of the program. It can be a report template or a
dataset specification (variable name, format and description) for example.
Example(s)
Relevant code examples (call to the macro + any additional code needed) with corresponding
output.
Example 1: <Example 1 title>
Example 2: <Example 2 title>
...
Add link to the code template
Limitations
Limitations found by the user are listed here with date of finding and possible work around.
They will be fixed in later version. This section is updated along the way.
Change Log
Changes of the different releases
Ver #
Date
Reason for change
Download