Artifacts > Environment Artifact Set > Programming Guidelines


Programming Guidelines		 Describes the conventions to be used when working with the programming language.
Role: Software Architect
Enclosed in: Software Development Plan
Template:
Examples: (may be used as-is)

Input to Activities: Output from Activities:

Purpose To top of page

The purpose of the Programming Guidelines is to describe how you write code.

Brief Outline To top of page

(hyperlinks into HTML template in a new window)

1.       Introduction         
    1.1     Purpose     
    1.2     Scope     
    1.3     Definitions, Acronyms and Abbreviations     
    1.4     References     
    1.5     Overview     
2.       Code Organization and Style
3.       Comments
4.       Naming
5.       Declaration         
6.       Expressions and Statements   
7.       Memory Management
8.       Error Handling and Exception      
9.       Portability
10.      Reuse               
11.      Compilation issues               
12.      Annex: Summary of Guidelines              

Timing To top of page

Programming Guidelines should be developed during the early Elaboration Phase, before final-quality code assets are developed.

Responsibility To top of page

The Role: Software Architect is responsible for the integrity of the Programming Guidelines.

Tailoring To top of page

You should adjust the outline of the Programming Guidelines:

  • Some sections may be removed, or added, to handle the specific features, and limitations of the specific programming language.
  • Some of the sections may be irrelevant for your project.
  • The order of the various sections may vary, depending on the system's stakeholders and their focus or interest.
 

Copyright  © 1987 - 2001 Rational Software Corporation

Display Rational Unified Process using frames

Rational Unified Process