Dokumentation

Heute sind wir über das Thema Dokumentation
gestolpert und haben uns eine knappe Stunde über unsere Best
Practices in Sachen Dokumentation unterhalten. Hier einige
Themen, die wir berührt haben: 


Corona Warnapp Dokumentation

Kommentare als Dokumentation

Genertierte Dokumentation

JIRA

Trello

Arc42

Dr. Gernot Starke

AsciiDoc

Markdown

UML

PlantUML

Dot

Real World PlantUML

LucidChart

Confluence

MediaWiki

Prettier

Code Formatter

Static Code Analyzer

CodeGlance for Intellij

Sequence Diagram

State Machines

C4 Model

Structurizr

C4 PlantUML

ERM

Beratersprech Twitter

Testen

Gherkin (Cucumber, BDD)



Gregor Tudan ist Softwareentwickler und Berater bei der Cofinpro
AG.


Martin ist selbständiger Softwareentwickler.


Feedback ist sehr willkommen. Gern direkt per Twitter an Gregor
(@Greg0rT) oder Martin (@felbit).


Wir sprechen ca. monatlich über Software, Werkzeuge, Sprachen und
Softwareentwicklung im Allgemeinen. Dabei sind wir hochgradig
subjektiv und betrachten alles durch unsere Brille, ohne Anspruch
auf Vollständigkeit oder Richtigkeit.