EPRI Software Manual Template
The software manual must conform to the EPRI Software Manual Template (4 MB). The template (.dotm) contains pre-made styles and auto-text.
Submit the manual as a Microsoft Word (.doc) document in a directory called "Manuals" with the software. Remember to scan the manual for plagiarism prior to submittal.
Note: Prior to SQA submittal review the Research Integrity Policy for iThenticate compliance.
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
Source Code Build Instructions
Developer must provide Source Code Build Instructions to SQA along with the software code for all software developed for EPRI. These build instructions must include information beyond just including/naming the source code and compiler(s), such as:
- Specifics of the build platform (such as operating system, build tools)
- Dependencies on native/platform libraries
- References to other third-party software (including version numbers)
- Values for build tool settings, command line switches, etc.
- Includes scripts/settings/configuration for installers (e.g., setup.exe)