Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Tip

Starting from Alex Xu (book), a 4-step process for effective system design would be great !

Step 1 : Understand the problem and establish the design scope

  • Understand the context and the constraints : ask questions to establish the type of constraints (technological, infra, etc.).
  • What specific features we are going to build ?
  • How many users does the product have ? How many users do we expect in the future ?
  • How fast the company anticipate to scale up ? 3 months, 6 months and 1 year ?
  • What is the company's technology stack ? What is the technological legacy ? What existing services we might leverage to simplify the design ?

Example of questions : What is the traffic volume ? What is the expected traffic volume after a time X ? etc.

Step 2 : Establish a high-level design 

  • Click "Edit" to enter the Confluence editor and use the page layouts feature to structure your content using sections and columnsEstablish an initial blueprint for the design according the step 1.
  • Use headings to format your text and drag and drop images into your page to provide visual interest.
  • Click "Insert" and select "Other Macros" to add macros for navigation, special formatting and other media.



Panel

On this page:

Table of Contents


Step 3 : Design deep dive

Here are some tips for organising your content.

  • Change the page order

The sidebar on the left displays your pages in a hierarchy. If you have Space Administrator permissions you can click "Space Tools" > "Reorder Pages" to move pages around.

  • Add labels

Labels help keep pages organised and make it easier for you to find the information you need. Click "Labels" at the bottom of a page to add or edit. The "Related pages" section on this page uses labels too!

  • Make templates

Standardise and speed up the page creation process with templates. You can create and format a template with page layouts, standard headings and instructional text for hints and guidelines. Check out our sample page on "Making a template"

Step 4 : Establish the pros and the cons