Guideline#

Implementation Guideline
status: valid
status: valid
tags: implementation
gd_guidl__implementation
Process Guideline

This document describes the general guidances for implementation based on the concept which is defined Concept Description. In the concept is a example of a Detailed Design included.

Workflow for Implementation#

This section describes which steps are need for implementation.

  1. Consult which programming languages, design/coding guidelines and tools are used for Software development within the Software Development Plan Software Development Plan (doc__software_development_plan).

  2. Create a Detailed Design by using the template Detailed Design Templates (gd_temp__detailed_design). In this step, the components are broken down into smaller, independent units that can be tested separately during the unit testing phase. The detailed design shall be so exact, that test and implementation can be run simultaneously.

  3. Implement the source code, by using the coding guidelines Coding Guidelines CPP (gd_guidl__cpp_coding_guidelines) for C++, or <TBD> for Rust.

  4. Create a pull request for your change.

  5. Detail Design and Code Inspection is done to review the code of the software and detect errors in it.

  6. Check the results of the static and dynamic code analysis (this inlcludes compiler warnings).

  7. Fix or justify the errors.

  8. Merge the pull request.

  9. Create a follow up ticket if not all findings could be fixed.