Artifact: Programming Guidelines
 Programming Guidelines |
Describes the conventions to be used when working with the programming language. |
| Worker: | Architect |
| Enclosed in: | Software Development Plan |
| Template: | Word template |
Purpose
The purpose of the Programming Guidelines is to describe how you write code.
Brief Outline
1. Objectives
A brief description of the purpose of the Programming Guidelines.
2. Scope
A brief description of what the Programming Guidelines apply to; what is affected or influenced by this document.
3. References
A list of related or referenced documents.
4. Code organization and style
A description of the size of a module, layout of a module, space, nesting, legibility, and so on.
5. Comments
A description of the use of comments.
6. Naming
A description of how each kind of entity (such as types, variables, and subprograms) should be named.
7. Declaration
A description of how declarations should be written.
8. Expressions and statements
A description of how expressions and statements should be written.
9. Memory management
A description of how memory should be managed.
10. Error handling and exception
This section gives rules and guidelines on how error handling and exceptions should be handled.
11. Portability
This section describes special rules to ensure portability across different platforms and compilers.
12. Reuse
This section gives rules and guidelines to foster easier reuse.
13. Compilation issues
This section describes dependencies between modules, compiler directives, and so on.
14. Annex: Summary of guidelines
This section summarizes all guidelines; one line for each.
Timing
Programming Guidelines should be ready before the project starts, or at least before the Constructions phase begins, for unprecedented systems.
Responsibility
The Worker: Architect is responsible for the integrity of the Programming Guidelines.
Tailoring
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.
