Christopher
Stoll

Software Development Guidelines 03b

At my company I have seen a lot of bad software development practices over the years, so I have created a set of software development guidelines to help establish a set of best practices and baseline software requirements. I am publishing a series of experts from those guidelines here so that I might get some useful feedback that will help improve them.

Documentation

All software must be documented. In addition to the specification documents outlined above, there normally should be at least two levels of documentation: the user level documentation and the administrator level or technical documentation. Some very small programs are so intuitive that user level documentation is not really required, but administrator level documentation should always be provided.

continue reading


Software Development Guidelines 03a

At my company I have seen a lot of bad software development practices over the years, so I have created a set of software development guidelines to help establish a set of best practices and baseline software requirements. I am publishing a series of experts from those guidelines here so that I might get some useful feedback that will help improve them.

Development

Accessibility

It is important when writing programs to allow access to people with disabilities. Creating software that is accessible by people with disabilities is relatively easy since most modern operating systems have already incorporated these features. The main goal of the developer in this regard should be simply not to interfere with the features already provided by the operating system.

continue reading


Software Development Guidelines 02e

At my company I have seen a lot of bad software development practices over the years, so I have created a set of software development guidelines to help establish a set of best practices and baseline software requirements. I am publishing a series of experts from those guidelines here so that I might get some useful feedback that will help improve them.

Software Repository

Before development begins a source code repository needs to be created in an established source code repository area. Source code repositories must reside on a mass storage devices, such as a NAS or SAN, that is regularly backed up and maintained by the server group. Source code repositories must reside on equipment maintained outside of the development group.

continue reading


Software Development Guidelines 02d

At my company I have seen a lot of bad software development practices over the years, so I have created a set of software development guidelines to help establish a set of best practices and baseline software requirements. I am publishing a series of experts from those guidelines here so that I might get some useful feedback that will help improve them.

Platform Specification

The platform specification, sometimes referred to as system requirements, should clearly describe all of the technologies that will be utilized in order to implement the solution. The specification should include the programming language, the development tools to be used and the client and server systems to be developed for.

continue reading


Software Development Guidelines 02c

<At my company I have seen a lot of bad software development practices over the years, so I have created a set of software development guidelines to help establish a set of best practices and baseline software requirements. I am publishing a series of experts from those guidelines here so that I might get some useful feedback that will help improve them.

Requirements Specification

The requirements specification should detail all of the processes and functionalities that the finished software should contain. This specification should include both functional specifications and non-functional specifications. The functional specification should employ use cases that describe the users interaction with the system (Graphical User Interface, Reporting Requirements). And, the non-functional specification should include any constraints not imposed by the user (Database Requirements, performance requirements, quality requirements).

continue reading


Software Development Guidelines 02b

At my company I have seen a lot of bad software development practices over the years, so I have created a set of software development guidelines to help establish a set of best practices and baseline software requirements. I am publishing a series of experts from those guidelines here so that I might get some useful feedback that will help improve them.

Administrative Specification

Application Owner

Every application, including internally developed applications, being used in the Company should have an application owner. This needs to be established prior to development. This designation should include a title or position as well as a proper name. In the event that the original application owner leaves the company, it should be clear who will inherit the role of application owner.

continue reading


Software Development Guidelines 02a

At my company I have seen a lot of bad software development practices over the years, so I have created a set of software development guidelines to help establish a set of best practices and baseline software requirements. I am publishing a series of experts from those guidelines here so that I might get some useful feedback that will help improve them.

Planning

No code should be written until a plan is defined.

continue reading


Software Development Guidelines 01

At my company I have seen a lot of bad software development practices over the years, so I have created a set of software development guidelines to help establish a set of best practices and baseline software requirements. I am publishing a series of experts from those guidelines here so that I might get some useful feedback that will help improve them.

Introduction

Intent

The intent of this document is to establish guidelines for software development which should help reduce total cost of ownership in the long term, ensure quality and consistency across the North American region, and implement a set of checks and balances between the various IT groups that improve operational transparency and reduce organizational risks.

continue reading