Prinzipien guter Dokumentation

Als ich dieses Kapitel ausgearbeitet habe, habe ich mri eine lange Zeit die Frage gestellt, wie nenne ich es denn. Ich habe mich für Dokumentationsprinzipien entschieden. Ich möchte in diesem Kapitel behandeln, was gute Dokumentation ausmacht. Und definitiv macht gute Dokumentation aus, dass Ihre Zielgruppe mit darauf behält. Bei Architekturdokumentationen ist die Zielgruppe nicht immer ganz eindeutig, aber man kann zumindest sagen, dass es sich an Architekten und Softwareentwickler richtet. Genauso wie dieses Training. Aus diesem Grund gehe ich davon aus, dass Sie als meine Zielgruppe und als Architekt oder Entwickler sich mit den Clean Code-Prinzipien auskennen. Und diese möchte ich jetzt nicht nur auf Code, sondern auf Dokumentation anwenden. Hierzu habe ich mir sechs Prinzipien herausgesucht, wobei das eine oder andere vielleicht nicht ganz so bekannt ist. Das, womit wir starten wollen, ist Keep it sim ple, stupid. Mit Keep it simple, stupid meinen wir, dass etwas möglichst…