A Partially Complete Guide to Build, Test and Deploy

You may consider adopting some of the style when documenting your project.

A partially complete guide to build, test and deploy !!

Pro-Skill Employment Agency

A sample report covering the documentation of stages:

Building Testing and Deployment

Charles Forth 1. INTRODUCTION...... 1 1.1 Case Background...... 1 1.3 The Problem...... 1

2. Testing the components...... 3

3. User Guide...... 7 3.1 Introduction...... 8 Welcome to the Pro-Skill Employment Database help file...... 8 3.1.1 Specifications...... 8 System Specifications...... 8 3.1.2 Our Philosophy...... 8 Our philosophy...... 8 3.1.2 Contents...... 9 Table of contents...... 9 3.1.3 How to...... 9 3.1.3.1 Installation...... 9 Installation...... 9 3.1.3.2 Navigation...... 10 Navigation...... 10 3.1.3.3 Selection...... 11 Selecting an applicant...... 11 3.1.3.3 Previewing letter...... 12 The interview letter...... 12 3.1.3.4 The letter...... 13 The letter itself...... 13 3.1.3.5 Closing forms...... 13 Closing the forms...... 14

Appendix A...... 15

References...... 21

Contents...... 22

Terms of reference...... 23 1. INTRODUCTION A brief introduction

In this section I will remind the reader of the necessary background information to enable you the reader to better understand the purpose of this case study. This information includes a history of the business, a description of the business’s current facilities, and the descriptions of the problems that triggered the project.

1.1 Case Background Background information

Symons Networks INC is a large company that was founded in 1995. The company’s main business premises are located in Teesside, UK. Currently, that location has over 850 full time skilled employees.

Four additional smaller premises are located throughout the UK and the company is thinking about becoming a multi-national concern, of the smaller branches the numbers of employees range from 75 to 250.

Approximately 50 employees are employed with the company’s maintenance departments, which is responsible for the maintenance of building’s networks and grounds. The main department of Symons Networks consists of 4 buildings that are spread out over the 2,000- acres.

The Maintenance Department has grouped the buildings into zones and assigned a group of employees to provide maintenance for the buildings within that zone.

Each zone is assigned a group of employees that collectively possess the skills needed to provide proper upkeep. Such employees include technicians, electricians, and IT staff, and the like.

The Maintenance Department also has a group of employees with special skills that are assigned to zones for special projects that may arise.

1.3 The Problem Detailing the problem

In September of 2003 John Collins and his management staff completed a one-week retreat aimed at assessing the Maintenance Department’s operations. Several initiatives resulted from this retreat. It was determined that the most important initiatives were those that primarily dealt with the company’s call out service which provides specialist’s in several fields sent out to troubleshoot varying issues that arose from time to time in the companies regional offices.

Often properly qualified skilled personnel were unavailable due to being tied up on other tasks or sickness, on holidays etc. The amount of lost business due to network down time and other issues has reached an alarming total.

1 It has been estimated that over £625,000 worth of business is lost each year. John Collins has decided that something must be done to get the losses under control. Thus, he is giving top priority to the recruitment of new extra skilled staff.

Unfortunately, often the skilled personnel needed are unavailable when they are needed by the company, there seems to be a general shortage of properly qualified skilled personnel in the areas needed. Advertisements in the local press have proved fruitless.

2 2. Testing the components Testing the web site

Pro-Skill Web Presence Test Plan Condition Actions Taken Action Results Expected Results Passe Tested For d Error checking No data entered Error page Error page must be Yes on inputs in input fields generated generated requesting requesting data data input into fields into fields Error checking URL entered into Start page opened Start page must open Yes of URL browser and up up selected Hyperlinks Hyperlinks were Relevant pages Relevant pages must Yes error check selected opened open up Data Forms were filled Perl generated The Perl script must Yes submission with data and Thank you display a thank you error check submitted message was message displayed

2.1 Perl script test Testing the server side scripts

Pro-Skill Perl Script Test Plan Condition Actions Taken Action Results Expected Results Passe Tested For d Data Data was input Output file was Data must be processed Yes processing to script for created containing and an output file created processing details from inputs containing data from input fields Error No data entered Error page was Error page must be Yes processing into form fields generated generated

2.2 Application installation test Testing the installation routine

Pro-Skill Application Set-Up Test Plan Condition Actions Taken Action Results Expected Results Passe Tested For d Installation to Application was Application was The application must Yes drive letter installed to installed to drive be installed to the

3 several drive letter chosen relevant drive letters chosen by the user Icon test The application The actions taken The relevant Yes icons in the start opened the relevant processes must be menu were processes opened by selecting selected the icons Uninstaller Uninstaller was The application was The application must Yes test selected uninstalled be uninstalled Correct The correct The application If the correct Yes Password test password was accepted the password is input the [relevant to input password and installation must registered carried on with proceed version only] installation Incorrect The incorrect The application If an incorrect Yes Password test password was refused to continue password is input [relevant to input installation then installation must registered fail version only]

2.3 Application test Administration Version

Pro-Skill Application Test Plan Condition Actions Taken Action Results Expected Results Passe Tested For d Auto-start of The application The application Upon start up the Yes welcoming was started by opened and the welcoming menu form menu clicking the welcoming start must appear ready relevant icon menu appeared to be used for navigation Employment The employment After selection the The employment Yes area selection fields buttons relevant areas forms areas forms must were selected opened and the open and the welcome menu welcome form must closed close Specific field The specific field The employment The employment Yes selection buttons were area menu closed area form must close selected and the specific field and the chosen field form opened form must open Data display The chosen field The specific field Upon the choosing Yes test was selected form opened of a specific area, showing data the form must open and display data Form button The go to last The data concerning The data concerning Yes test record button the last record was the last record must was selected displayed be displayed Form button The go to next The data concerning The data concerning Yes test record button the next record was the next record must was selected displayed be displayed Form button The go to first The data concerning The data concerning Yes test record button the first record was the first record must was selected displayed be displayed Form button The fees letter The data concerning The data concerning Yes

4 test button was the fees record was the fees record must selected displayed as a letter be displayed as a letter Form button The print letter The letter was The fees letter must Yes test button was printed be printed selected Form button The Add record The form allowed The form must allow Yes test button was data to be added new data to be selected and a new record added to the created database Form button The save record The new data record The new data must Yes test button was added was saved in be saved into the selected the database database Form button The undo button The data added to a The undo command Yes test was selected blank field was should undo the last undone action Form button The open MS Ms word was MS word must be Yes test word button was initiated initiated selected

2.3.1 Application test cont’d Continuation

Email link The email link An email addressed An email addressed to the Ye test was clicked to the client was client must be generated s generated Search test The search A search was carried A search must be carried Ye button was out on the given out on the given criteria s selected criteria Exit button The exit button The form closed and The form must close and Ye test was clicked the welcome menu the welcome menu must s re-opened allowing re-open and allow further further selections selections Internal The internal The internal workings The database must allow Ye database workings of the of the application administrators access to s access test application were were accessed the internal workings accessed

2.3.1.1 Application test Demonstration Version

Pro-Skill Application Test Plan Condition Actions Taken Action Results Expected Results Passe Tested For d Auto-start of The application The application Upon start up the Yes welcoming was started by opened and the welcoming menu form menu clicking the welcoming start must appear ready relevant icon menu appeared to be used for navigation Employment The employment After selection the The employment Yes area selection fields buttons relevant areas forms areas forms must were selected opened and the open and the welcome menu welcome form must closed close

5 Specific field The specific field The employment The employment Yes selection buttons were area menu closed area form must close selected and the specific field and the chosen field form opened form must open Data display The chosen field The specific field Upon the choosing Yes test was selected form opened of a specific area, showing demo data the form must open and display demo data Form button The go to last The data concerning The data concerning Yes test record button the last record was the last record must was selected displayed be displayed Form button The go to next The data concerning The data concerning Yes test record button the next record was the next record must was selected displayed be displayed Form button The go to first The data concerning The data concerning Yes test record button the first record was the first record must was selected displayed be displayed Form button The interview The data concerning The data concerning Yes test letter button was the client was the client record selected displayed as a letter must be displayed as a letter Form button The print letter The letter was The interview letter Yes test button was printed must be printed selected Data entry test Data entry into Data input was Data addition must Yes the field form was disallowed be disallowed tried

2.3.1.2 Application test Registered Version

Pro-Skill Application Test Plan Condition Actions Taken Action Results Expected Results Passe Tested For d Auto-start of The application The application Upon start up the Yes welcoming was started by opened and the welcoming menu form menu clicking the welcoming start must appear ready relevant icon menu appeared to be used for navigation Employment The employment After selection the The employment Yes area selection fields buttons relevant areas forms areas forms must were selected opened and the open and the welcome menu welcome form must closed close Specific field The specific field The employment The employment Yes selection buttons were area menu closed area form must close selected and the specific field and the chosen field form opened form must open Data display The chosen field The specific field Upon the choosing Yes test was selected form opened of a specific area, showing data the form must open and display data Form button The go to last The data concerning The data concerning Yes test record button the last record was the last record must was selected displayed be displayed Form button The go to next The data concerning The data concerning Yes

6 test record button the next record was the next record must was selected displayed be displayed Form button The go to first The data concerning The data concerning Yes test record button the first record was the first record must was selected displayed be displayed Form button The interview The data concerning The data concerning Yes test letter button was the client was the client record selected displayed as a letter must be displayed as a letter Form button The print letter The letter was The interview letter Yes test button was printed must be printed selected Data entry test Data entry into Data input was Data addition must Yes the field form was disallowed be disallowed tried Correct The correct The application If the correct Yes Password test password was accepted the password is input [relevant to input password and the installation must registered carried on with proceed version only] installation Incorrect The incorrect The application If an incorrect Yes Password test password was refused to continue password is input [relevant to input installation then installation registered must fail version only]

2.4 Auto start test Compact disk auto start

Pro-Skill CD Auto-Start Test Plan Condition Actions Action Results Expected Results Passe Tested For Taken d Windows auto CD was CD drive activated Application set up must Yes start enabled inserted into and began start when CD auto start is CD drive E: application set up enabled on the users system Windows auto CD was No activity from No activity must occur on Yes start disabled inserted into CD drive system CD drive. Auto CD drive E: start must not occur -

7 3. User Guide A user’s guide to using the product

3.1 Introduction An introduction to the help file

Welcome to the Pro-Skill Employment Database help file.

Here you will find all the information needed to help you the end user to use our product.

3.1.1 Specifications System Specifications

System Specifications

 Upon ordering your copy of our application you will have been asked to document your wanted specifications, including your operating system version and which version of Microsoft Office your company works with.

 Microsoft Access a key part of the MS Office suite MUST be installed on any system prior to the installation of our product.

3.1.2 Our Philosophy The philosophy of our company

Our philosophy

1 We at Pro-Skill endeavor to produce top quality software, giving you the client the very best selection of prospective employees that are available.

We cannot guarantee you will find the personnel you require but we do know that your prospects of filling your staffing requirements shall be greatly enhanced by using our software.

We hope you will be satisfied with our product.

Sincerely

The Pro-Skill Team.

3.1.2 Contents The table of contents

Table of contents

 Introduction  Specifications  Our philosophy  Contents  How to  Previewing interview letter  The letter itself  Closing forms and exiting the application

3.1.3 How to How to use the application

 In the following pages you will find diagrams and explanations on how to use the Pro- Skill application.

3.1.3.1 Installation An installation guide

2 Installation

1. Insert the CD into your CD-ROM drive. If you have auto play enabled the installation should start up automatically, if not or if you do not have auto play enabled then simply navigate to your CD-ROM drive which is usually your D: drive

2. Locate the file named setup.exe and double click upon it, installation should follow almost immediately

3. Once installation starts you will be asked to input your registration license number which can be found printed on the cover of your CD-ROM.

4. During the later stages of installation you will be asked to specify an installation directory, clicking next is fine for most people but if you wish to install to a different location, change the location in the given field.

3.1.3.2 Navigation How to navigate around the application

Navigation

1. Navigation To navigate around the application simply click on the button that applies to the field in which you are seeking employees.

3 2. Example if you wish to find a computer programmer you would click the button marked

Information Technology

3. From that point another window should appear containing IT professionals. Just click the applicable field name, it's a simple matter of choosing

IT Programming.

3.1.3.3 Selection How to select an applicant

Selecting an applicant

1. How to choose Once you have selected the field you wish, it's a simple matter of reviewing the available applicant's.

4 3.1.3.3 Previewing letter How to preview the letter

The interview letter

 How do you preview the interview request letter, easy click the "Interview Letter" button on the selection form.

 To print the interview letter just click the "Print Letter" button.

5  The address field of the letter shall be customized to your company address once you become a member.

 The date of interview can also be altered to your specifications. The default is one week after actually choosing the applicant.

3.1.3.4 The letter The letter itself

The letter itself

3.1.3.5 Closing forms Closing the forms and exiting the application

6 Closing the forms

 To close the application, simply click the "Exit Program" button.

To close the selected field form, simply click the "Close Form" button.

7 Appendix A

Installation of the application screenshots:

 Welcome to the set-up

 A data protection reminder

8  The password protection box The password is case sensitive and must be correct for installation to continue

 The result of entering an incorrect password Three attempts are permitted then installation will cease

9  The software license agreement The user must indicate agreement to continue

 User information entry point

10  Choose your installation directory

 Verify install details then proceed

11  Final installation in progress

 Installation is completed The program can now be used from the shortcut on the desktop

 The windows start menu icons

12 Program start or uninstallation can be begun here

 Uninstallation confirmation dialogue

 Uninstallation completed

13 References

 Web Design http://www.microsoft.com/office Microsoft Publisher

 Set-up maker http://www.indigorose.com Set-up factory

 Web server http://www.apache.org Apache web server

 CD burning software http://www.nero.com Nero burning rom

 Help file maker http://www.helpblocks.com Anthemion help blocks

 Database application http://www.microsoft.com/office Microsoft access 2003

14 Contents

 Front cover ...... i  Contents ...... ii  Terms of reference ...... iii 1  Introduction ...... 1 1.1  Case background ...... 2 1.3  The problem ...... 3 2  Testing components ...... 4 2.1  Perl script test ...... 5 2.2  Installation test ...... 6 2.3  Application test ...... 7 2.3.1  Application test contd ...... 8 2.3.1.1  Demonstration test ...... 9 2.3.1.2  Registered test ...... 10 2.4  Auto-start test ...... 11 3  User guide ...... 12 3.1  Introduction ...... 12 3.1.1  Specifications ...... 13 3.1.2  Our philosophy ...... 14 3.1.2b  Contents ...... 15 3.1.3  How to ...... 16 3.1.3.1  Installation ...... 17 3.1.3.2  Navigation ...... 18-19 3.1.3.3  Selection ...... 20 3.1.3.3b  Previewing letter ...... 21 3.1.3.4  The letter ...... 22 3.1.3.5  Closing forms ...... 23  Appendix A ...... 24  Appendix A ...... 25  Appendix A ...... 26  Appendix A ...... 27  Appendix A ...... 28  Appendix A ...... 29  References ...... 30

15 Terms of reference

The purpose of this report is to document the testing stages of the application.