Skip to main content

Implementation Proposal

Implementation Proposal (IMP) markdown template for ADO.

Markdown template

Copy the contents to an empty markdown file and start editing. Remove the help text in block quotes and any unused sections.

<!--- This template gives the general of an Implementation Proposal (IMP) for a hardware/software system/product/component or Epic/Feature. 
An IP can be used when the functionality requires more analysis that is done in preparation for Epics and Features. --->

# Implementation Proposal

<!--- Include a summary. --->

---

## Introduction

<!--- Give an overview and short description of the content of the component. --->
Introduction...

### Purpose and scope

<!--- The purpose of an IP is to document a technical evaluation before implementation, with the following purposes:
to analyze the technical impact
to give a rough estimation of the development effort
to provide input to decide weather to continue with the implementation
to describe alternative solutions --->

### References

<!--- Add links to other related IPs or other documents. --->

### Terminology

<!--- List specific terms and definitions used. --->
| Term | Definition |
| --------| ----------------------------------------------------------------------------------- |
| <Term> | <Definition> |

---

## Epics/Features covered

The following Epics/Features have been addressed in this IP:
| Epic/Feature | Title |
| ----------------| --------------------------------------------------------------------------- |
| <WorkItem Id> | <Title> |

---

## New and/or changed functionality

<!--- Write a brief description of function, with just enough detail to make it possible to reason about how it should be implemented in the next chapter.
Concentrate on major functionality and/or tricky parts. --->

### Proposed implementation

<!--- In this chapter, describe how the changes and/or additions to the product/function are to be implemented. --->

#### Alternative proposal

<!--- Alternative solutions may be specified. Present the alternatives and document pros and cons of all alternatives. --->

#### Open issues

<!--- Describe open issues that need to be resolved to implement this function. --->

### Interfaces

<!--- Describe internal and external interfaces and what they are used for. --->

### Design structure

<!--- Show and describe included components, if applicable. Refer to the architecture document and other relevant documents, and show how the proposed implementation fits into the existing design. --->
<!--- If applicable write a PlantUml diagram to show the structure. --->
This diagram shows...

```plantuml
@startuml Diagram
!include Diagram.puml
@enduml
```

#### Required changes to other parts

<!--- Mention all other parts of the system (e.g. products, interfaces, functions) that are influenced by your IP and how each part would have to be modified. --->

---

## Implementation activities

<!--- Describe new development methods and tools that will be required, if any. Describe the impact on documentation, testing, and installation. --->

### Effort estimation

<!--- If your IP contains alternative solutions, present one set of estimations for each of them. Describe the method of the estimation.
Let the estimation include design, implementation, documentation, and tests for hardware and software. --->

---

## Risks

<!--- Describe possible risks and what you propose to do to minimize the effect of them, for example, technical issues, resources, performance, etc.. --->

Owner: Software Development Team