Design Discussion Template
Introduction:
Introduction to this wiki page. The blocks this wiki page contains
Background:
Explain the background or existing structure/design and implementation for this feature/problem.
Problem Statement:
Explain the problem for which we are preparing this design brainstorm.
Key design problems:
Identify the key design problems and list them here.
Design:
Proposed design to solve Key design problems. It should have multiple options, pros and cons of each solution/option. Also, each option should have a data model and implementation design. Some of these things will be optional depends on the problem which we are trying to solve. Below is a sample template for design solution/option
Solution 1:
The topmost preferred solution which you think is the right solution
Description of this option.
Diagrams should be there for any workflows, components, data models, relations etc,.
List the tech choices and rationales.
Pros:
One line statement of advantage with this solution.
Cons:
One line statement of disadvantage with this solution.
Solution 2:
The 2nd topmost preferred solution which you think is the right solution
Pros:
One line statement of advantage with this solution.
Cons:
One line statement of disadvantage with this solution.