Design Document Layout

Posted on | Edited on | In

Reviewer Sheet

Right after the title, list stakeholders in sheet:

1
2
3
4
Username | Role      | Status   | Last Change
         | Reviewer  | Pending  | 2023-01-23
         | Approver  | Approved |
         |           | Waiting  |

Document profile

  • Author: xxx
  • Contributors: xxx
  • Intended audience: xxx
  • Created: xxx
  • Latest update date: xxx
  • Visibility: public| confidential | need to know
  • Status: draft | review | current | needs update | obsolete
  • Self-link: xxx
  • Team: xxx
  • Hotlist/ticket: xxxx

Sections

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# Context
  ## TL;DR
  ## Objective

# Requirements

# Design/Proposal (stopgap vs fullfleged solution)
  ## Preferred Approach
    chart: Pros | Cons | Effort
  ## Alternative Considered
    chart: Pros | Cons | Effort
  ## code fragment/proto, etc

# Comparison Analysis
  ## Reusability
  ## Backward Compatibility
  ## Ownership
  ## Leve of effort required
  ## Maintainability
  ## Testability
  ## Scalability

# High level architecture
# High level workflow (sequence diagram)

# Compliance
# Dependencies
# Integration Test
# Implementation Plan / Roadmap
# Reference

Diagram

Open source versatile tools to help with diagram:

0%