Software Documentation

EPRI Software Manual Template

If used, the software manual must conform to the EPRI Software Manual Template (1.02 MB). The template (.dot) contains pre-made styles and auto-text.

Download the Accompanying Procedure Manual (713 KB), which serves as a guide for completing the template. Submit the manual as a Microsoft Word (.doc) document in a directory called "Manuals" with the software.

Software documentation (e.g., Software Manual) is reviewed for:

• Organization & Appearance: Conforms to the EPRI Software Manual Template, looks professional, describes purpose of application, consistent throughout (check numbering, page numbering, fonts, etc.), correct spelling and grammar
  
  
• Installation & Un-Installation procedures including EPRI Mandatory Software Installation Information Statements (located inside EPRI Software Manual Template), system configuration requirements, and technical support information
  
  
• Operational Procedures: Describes all toolbars, menus, commands and options; calculations and examples documented correctly, documents differences between operating systems
  
  
• Test Cases / Sample Problems (or Tutorial)
  
  
• Tables, Graphs and Figures: Identical to application graphical user interface, consistent captioning and numbering, referenced in text, consistent with list or table of tables, graphs and figures