Skip to content

Latest commit

 

History

History

Design_Doc_Examples

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 

README.md

ML System Design Examples

This directory contains ML system design documents organized into two categories:

Directory Structure

├── Examples/             # Real-world–inspired examples
│   └── EN/               # English examples
└── Mock/                 # Educational mock examples
    └── EN/               # English mock examples

Categories

Example Documents

Located in the Examples/ directory. These are based on real-world scenarios but may be adapted or simplified for educational purposes. They maintain realistic complexity while remaining accessible for learning.

Mock Documents

Located in the Mock/ directory. These are educational examples created specifically for learning. They demonstrate best practices and common patterns using fictional companies or simplified scenarios.

Language Organization

Each category has language-specific subdirectories:

  • EN/ for English documents
  • Additional language folders can be added as needed

Contributing

When adding a new design document:

  1. Choose the appropriate category (Examples/ or Mock/).
  2. Place it in the correct language subdirectory (e.g. Examples/EN/).
  3. Follow the template from ../templates/basic_ml_design_doc.md.
  4. Include any necessary diagrams and supporting files.
  5. Update this README if you add a new language folder.