Frage zur Dokumentation selbsterstellter Software

[SR2021]

Hallo zusammen,

ich hätte mal eine Frage an die Softwareentwickler unter uns:
Könnte mir jemand von euch ( selbstverständlich unter Grundlage absolutem Stillschweigens) mal ein Beispiel zusenden wie bei euch selbstprogrammierte Software dokumentiert wird?

Hintergrund:
Wir nutzen ein Warenwirtschafts- / Werkstattsystem das speziell für unsere Bedürfnisse programmiert, entwickelt und über die Jahre weiterentwickelt wurde.
Das Programm läuft top, ist einfach zu bedienen und wird auch stätig an aktuelle Situationen angepasst und weiterentwickelt.

Zusätzlich zu dem Programm gibt es eine App mit der Waren über mobile Endgeräte lagertechnisch gescannt werden und ggf. Fotos zu den Vorgängen hinzugefügt werden können.
Die App wurde 2017 programmiert und lief seitdem problemlos, programmiert wurde die App damals in Ionic.

Nun scheint es jedoch ein Problem in der Kommunikation mit dem Server zu geben und Bilder können nicht mehr hochgeladen werden.
Da die Firma die App Programmierung in der Zwischenzeit jedoch umgestellt hat, müsste jetzt dafür extra eine Ionic Produktionsumgebung aufgebaut werden um das Problem zu analysieren.
Wir haben keinen Wartungsvertrag o.ä., würde also komplett auf T&M laufen.

Um diesen Schritt erstmal nach hinten anzustellen, habe ich die Firma dann gebeten mir zu sagen auf welcher unserer VMs die API läuft und mit welchen Diensten diese verknüpft ist um Berechtigungsprobleme auszuschließen. ( Änderungen an der DB funktionieren über die App, nur das hochladen von Bildern in die Ordner auf dem Server nicht )
Ich hätte erwartet, dass so etwas separat dokumentiert wird und in der Dokumentation mit ein paar Klicks zu finden, ist es aber anscheinend nicht, dafür muss man jetzt erst in die App schauen, also die komplette Umgebung wieder aufbauen.

Da ich selbst ansonsten relativ wenig Berührungspunkte mit Softwareentwicklung habe würde mich mal interessieren wie weit die interne Dokumentation der Software bei euch so geht und ob es eine Art Handouts für den Administrator des Kunden über die Kommunikationswege- und Zugriffe gibt. Also quasi so banale Sachen wie welche Ports man in der Firewall offen halten muss, welche Dienste in Abhängigkeit zu der Software stehen, gibt es eventuell APIs zu anderen Programmen ( wenn ja wo liegen / arbeiten die) etc.

Vielen Dank vorab!




 

[tCKTheOfficial]

Bei uns gibt es zwei verschiedene Dokumentationsarten.

Einmal die Dokumentationen, die für alle In der Abteilung gedacht sind. Dazu gibt es die Dokumentationen, die jeder selber erstellt hat. Bestehen anfragen zu Problemen und man selber hat kein Doku tauscht man sich auch aus. Jeder Dokumentiert etwas anderes. Die Leute wollen sich auch auch irgendwie "unkündbar" machen.

[MartinSt]

Du findest Beispiele (gute und schlechte Dokumentationen) in diversen OpenSource Projekten, ohne dass hier jemand seinen Job riskieren muss und dir interne Dokus raus gibt.