Christopher
Stoll

Software Development Guidelines 03e

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.

Uncoupled Configuration

Configuration options should be separated from the program. A program should be able to be configured using external configuration information whenever possible. This is especially true for file paths and network locations.


Software Development Guidelines 03d

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.

Quality

Any software written for use in the Company should not only perform in a consistent manner, but it should also perform reliably and in accordance with the users’ expectations. In order to accomplish this programmers must plan how the software should work, continually test the application as it is developed (unit testing, integration testing, functional testing, etc.), and must thoroughly test the application to ensure that it is operating as planned before it is released into a production environment.


Software Development Guidelines 03c

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.

Security

There are several layers of security used in the Company’s computing environment, none of which is likely to change for any single applications, so it is important to have at least a basic understanding of some of the general constraints. This section provides an overview of IT security concerns across multiple IT groups, check the intranet or ask an IT analyst for more detailed information on any of the following sections.


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.


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.


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.


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.


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).