Sitecore Module Design presentation during our Sitecore Usergroup Meeting in Bielefeld.

1. Unsichtbare Technologie. Sichtbare Kreativität. netzkern.
27. Oktober 2015
The Good, The Bad and The
Ugly Sitecore Module

2. Unsichtbare Technologie. Sichtbare Kreativität. netzkern.
Agenda
1. Intro
2. Architecture Best Practices
3. Recommendations
4. Clean Code

3. Unsichtbare Technologie. Sichtbare Kreativität. netzkern.
Intro

4. Unsichtbare Technologie. Sichtbare Kreativität. netzkern.
About me
Maksym Ponomarenko
Sitecore Consultant
netzkern AG

5. Unsichtbare Technologie. Sichtbare Kreativität. netzkern.
Paraphrasing classic
There are two kinds of Modules in the world, my friends:
- With Flexible Architecture
- Ugly

6. Unsichtbare Technologie. Sichtbare Kreativität. netzkern.
Architecture Best Practices

7. Unsichtbare Technologie. Sichtbare Kreativität. netzkern.
Pipelines and Processors

8. Unsichtbare Technologie. Sichtbare Kreativität. netzkern.
Managers and Providers

9. Unsichtbare Technologie. Sichtbare Kreativität. netzkern.
ID Generator

10. Unsichtbare Technologie. Sichtbare Kreativität. netzkern.
Logs

11. Unsichtbare Technologie. Sichtbare Kreativität. netzkern.
Clean Code

12. Unsichtbare Technologie. Sichtbare Kreativität. netzkern.
Understanding messy code
Developer spends 60-80% time in understanding code
Messy code is a significant impediment

13. Unsichtbare Technologie. Sichtbare Kreativität. netzkern.
Megamoth
Never make Mega Monolytic Methods
Don‘t build God classes
Write short methods
and
Class should have only one reason

14. Unsichtbare Technologie. Sichtbare Kreativität. netzkern.
Clean Code
“Clean code can be read, and enhanced by a developer other
than its original author. “
"Big" Dave Thomas
Founder of OTI, godfather of the Eclipse strategy

15. Unsichtbare Technologie. Sichtbare Kreativität. netzkern.
Use S.OL.I.D principles
Single responsibility
Open-closed
Liskov substitution
Interface segregation
Dependency inversion

16. Unsichtbare Technologie. Sichtbare Kreativität. netzkern.
Design Stamina Hypothesis

17. Unsichtbare Technologie. Sichtbare Kreativität. netzkern.
Hell

18. Unsichtbare Technologie. Sichtbare Kreativität. netzkern.
Recommendations

19. Unsichtbare Technologie. Sichtbare Kreativität. netzkern.
Recommendations
Module should be well docummented
1. Instalation Guide
2. User Guide
3. Developer Guide

20. Unsichtbare Technologie. Sichtbare Kreativität. netzkern.
Recommendations
Do not override standard Sitecore functionalities

21. Unsichtbare Technologie. Sichtbare Kreativität. netzkern.
Recommendations
Do not depend on other modules

22. Unsichtbare Technologie. Sichtbare Kreativität. netzkern.
Recommendations
Support CM-CD environment

23. Unsichtbare Technologie. Sichtbare Kreativität. netzkern.
Recommendations
Do not forget about localization
Translate.Text("LoremIpsum");

24. Unsichtbare Technologie. Sichtbare Kreativität. netzkern.
Recommendations
Move Settigns to items

25. Unsichtbare Technologie. Sichtbare Kreativität. netzkern.
Recommendations
Provide a Sitecore Speak Application to configure your module

26. Unsichtbare Technologie. Sichtbare Kreativität. netzkern.
Your project can be supported by a violent gunman who knows how to find you
Remember

27. Unsichtbare Technologie. Sichtbare Kreativität. netzkern.
Vielen Dank für Ihre
Aufmerksamkeit.