Computer Science Complete Program/Application
Documentation Guidelines
(Project Name)
Documentation should include the following:
I. Project Overview
· Describe Purpose of the project
· Technical Aspects
· Hardware Requirements (Processor, Speed, RAM, etc.)
· Software Requirements (OS, IE, Java, etc.)
· Network Diagram / Data Flow
· System Interfaces
· Installation Procedure
· User Guidelines
· Documentation
· Cheat Sheet
· Contact list
· Website
· URL (Help documentation)
· Compatibility
II. Testing
· System Testing
· Test scripts
· Functional Testing
· Test scripts
III. Issue Logs
· Prioritize Issues
· Status
· Resolution
IV. Service Learning Essay
V. End User Acceptance
Documentation Guidelines Rev. 2/11/12
Page 1 of 1