Repo einrichten und Anforderungen definieren

[dwcaesar]

In der README.md soll der Verwendungszweck und die Anforderungen am Programm detailliert festgehalten werden.

Anhand der Anforderungen können einzelne Details der Umsetzung festgelegt werden, sowie die allgemeine Struktur sowie Prozessabläufe entwickelt werden.

Abläufe und Strukturen sollen in der Form von Diagrammen (UML) abgebildet werden.

[dwcaesar]

I've read about a few ways to organize such a project properly. I want to practice them in this project.

A few principles i want to focus on:

• Test Driven Development
• Domain Oriented Programming
• Clean architecture
  • Screaming architecture: The source code should look like a electricity billing software
  • Separating business logic from frameworks

Of course, some of them require a little planning ahead. So i have to draw a few UML diagrams beforehand:

• Use case diagram
• Business logic diagram and notation (I'm used to flowcharts, but these do not include exceptions or module definitions)
• Component diagram (a less detailed view on the structure)

This also means, that i have to rework almost everything i programmed so far. But this has to wait until the intended behavior has been documented and a first draft of the software structure has been made.