Name Best Practice
IDnr
Date adjusted
Description of the content
Type of document
ASL Process
Size of the application
management team:
Small (number fte < 10),
Medium (number fte 10 – 20)
and/or Large (number fte> 20).
Remarks
ASL BiSL Foundation
PO-box 9769
3506 GT UTRECHT
Developers handbook maintenance
205_BP_E
November 22th, 2006
Template for a developers handbook used in an offshore environment
Template
Realization
√ Medium
√ Large
T: +31 (0) 30 753 1424
F: +31 (0) 30 755 1502
Chambre of Commerce Utrecht and surroundings:
I: www.aslbislfoundation.org
E: info@aslbislfoundation.org
08106817
Developers Handbook Maintenance
Place
Date
Author
Status
Concept 0.1
Developers Handbook
Maintenance
November 22th, 2006
2/9
Version control
Version
0.1
Date
Author
Description
Initial document
Distributionlist
Version
0.1
Date
To
Developers Handbook
Maintenance
November 22th, 2006
3/9
Table of contents
1
Introduction ...................................................................................................5
1.1
1.2
1.3
1.4
2
Development Environment ...........................................................................6
2.1
2.2
2.3
2.4
2.5
2.6
2.7
3
Servers .....................................................................................................6
Developer Workstations ...........................................................................7
Directory Structure for Code at various stages ........................................7
Tools and Languages ..............................................................................7
Environment Variables .............................................................................7
Unit Testing Environment .........................................................................7
Reporting and Tracking ............................................................................7
Development Process ...................................................................................8
3.1
3.2
3.3
3.4
3.5
3.6
4
Purpose of the document .........................................................................5
Scope of the Document ...........................................................................5
References and Prior Readings ...............................................................5
Abbreviations and Acronyms ...................................................................5
Coding Guidelines ....................................................................................8
Project Specific Code Review Guidelines ................................................8
Code Check-in/Check-out procedures .....................................................8
Build / Integration methodology ...............................................................8
Release Methodology ..............................................................................8
Project documents maintenance .............................................................8
Appendix 1 – Installation of Tools ...............................................................9
Developers Handbook
Maintenance
November 22th, 2006
4/9
1
Introduction
1.1
Purpose of the document
With application maintenance of all the <company> applications being shifted to
offshore facility in <country>, it has become the need of the hour to use a
common methodology for the maintenance activities to be carried out for the
cluster of applications. This document addresses the application set up
procedure, hardware / software configuration and coding and testing guidelines
to be followed during the course of the project. In addition to these, it discusses
about the version control mechanisms to be followed, reporting and tracking of
the change requests / issues and the delivery structure of the releases to be
made.
The purpose of the Developer’s Handbook is to provide a new employee joining
the Maintenance team, a set of guidelines to be followed during the maintenance
activities carried out for each application.
1.2
Scope of the Document
This document is intended to provide information about the following areas:
 Setting up of the Server Development Environment (Local Database
Server)
 Setting up of the Workstation Development Environment
 Installing Development Products and Tools
 Configuration Settings
 Build Process
 Unit Testing Process
 Reporting and Tracking
 Coding guidelines to be followed
 Documents that are created and maintained for this projects
1.3 References and Prior Readings
1.4 Abbreviations and Acronyms
Abbreviation /Acronyms
Description / Definition
Developers Handbook
Maintenance
November 22th, 2006
5/9
2
Development Environment
2.1 Servers
There is one database server deployed for the Maintenance activities. Details of
this server are given below.
Development Server
Purpose
Name
Development, Maintenance, Integration and Unit testing
(IP address:)
Brand & Model
Hardware
Hard Disk Size
Amount of Memory
Operating System
Database
User-id:
Password:
Network
Administrator
Physical Location
Connectivity between Servers
& Development Workstations
Privileges to each user
User Accounts
Developers Handbook
Maintenance
November 22th, 2006
6/9
2.2 Developer Workstations
Developer Workstation is used for Incident Management, Development,
Maintenance and Unit Testing.
All the members of the team are provided with a Developer Workstation.
Following configuration is applicable for all the developer workstations:
2.3 Directory Structure for Code at various stages
Refer Configuration Management Plan for the complete directory structure that is
followed in the Maintenance Project for source code control.
The following considerations are made during directory structure
maintenance:
 The directory structure containing the project source and executable files
 The build directory structure
 The release directory structure
 Directory structure on the Developer’s Workstations.
 Network directories to be mapped for backup
2.4 Tools and Languages
List of all the tools required on the Servers and Workstations
2.5 Environment Variables
Details of the environment variables for each user on the servers and
workstations:
2.6 Unit Testing Environment
2.7 Reporting and Tracking
Developers Handbook
Maintenance
November 22th, 2006
7/9
3
Development Process
3.1 Coding Guidelines
3.2 Project Specific Code Review Guidelines
3.3 Code Check-in/Check-out procedures
3.4 Build / Integration methodology
3.5 Release Methodology
3.6 Project documents maintenance
Developers Handbook
Maintenance
November 22th, 2006
8/9
4
Appendix 1 – Installation of Tools
Developers Handbook
Maintenance
November 22th, 2006
9/9