This document is written to guide a fictitious
development team on their implementation of a .NET project. However, it is
based on a real world project, the creation of my website www.peterbox.com.
These development guidelines help a team to solve common
problems, to structure programs consistently, to write predicable code and to perform
testing in a uniform way. The goals are:
•
Improvement of software quality through:
- standardised
coding
- consequent
checking for error conditions
- early
and thorough testing
- reporting
of unexpected problems during operation (tracing)
•
Easier maintenance through:
- documentation
- standardised
structuring and commenting of programs
- naming
conventions
•
Shortening of steep learning curve of .NET technology
This guide is not a substitute for the many detailed
and voluminous books regarding the broad range of technologies covered here. Instead
it covers all the practical details which are often left out by those books,
but which are important for a successful project.
Often there are several good implementation choices
available. To achieve good quality and ease of maintenance, it is not that
important which choice is taken, but that everybody follows the same guidelines.
Nonetheless, I try to explain the reasons behind my recommendations.
Please note that this document is a work in
progress. I have outlined the structure of the document quite completely, but
several topics need further investigation. They are marked with ???.
Nonetheless, this document is a great help for anyone starting a new .NET
project.
If you have comments to these guidelines, I抦 very
interested to hear from you. You can reach me at: contact@peterbox.com.
Chapters Overview