Skip to content

Latest commit

 

History

History
55 lines (28 loc) · 1.34 KB

design-guidelines.md

File metadata and controls

55 lines (28 loc) · 1.34 KB

< devops-project-template

Design Guidelines

The design guidelines ensure uniform, understandable design based on proven solutions.

Clone this repo and document your project plan here:



Content

Tips and hints

  • Never sacrifice simplicity and elegance

    A design is perfect when nothing more can be taken away

  • Use standard notation (UML) for technical designs

  • Formulate the design using well known design patterns but don't overdo it

  • Avoid frameworks, prefer standard language constructs (avoid lock-in and regular porting overhead)

  • If a solution doesn't feel right, redesign or or backlog as engineering debt

  • The technical design does not need to be complete, just complete enough to start coding

Design Patterns

Design Patterns are 'solution templates'. Using design patterns is considered best practice in the industry as the design patterns are already tried and tested. Common design patterns include:

  • Singleton
  • Factory
  • Decorator
  • Adapter
  • Observer

See: