Tipps zum Thema Software-Dokumentation

Hay liebe Freunde des Programmierens,

da ich gerade meine erste größere Web-Anwendung entwickle, komme ich nun das erste mal wirklich mit dem Thema Software-Dokumentation in Berührung.
Leider hab ich von dem Thema bisher nicht viel Ahnung, außer das ich weiß das es echt wichtig ist. ^^'

Daher suche ich hier mal nach guten Tipps von euch und hoffe das ich mit eurer Hilfe eine halbwegs gute Dokumentation zusammen bekomme.

Bei dem Projekt handelt es sich um eine PHP Anwendung (Laravel Framework) mit einer API, später kommt noch eine JS Frontend Anwendung dazu, aber erst einmal der serverseitige Teil.

LG reav0r

Würd grundsätzlich sagen google mal ;) da findest alles recht detailiert

So ganz ganz grundlegend kannst es etwa so machen

1. Was war das Ziel, wie hast du es umgesetzt, welche Ansätze sind schiefgegangen.

2. Deine Perspektive, was macht welche Funktion, welche Datenstrukturen gibt es, wie sind sie verknüpft

3. Endnutzer Perspektive, was können sie machen, wie können sie es machen.

4. Admin Perspektive der das ganze installieren muss, was für Voraussetzungen gibt es, worauf muss er achten.

5. Welche Testcases wurden gemacht, was waren die Ergebnisse.

6. Versions History, Was wurde wann, wie geändert.

Würd dir aber wirklich ans Herz legen, dich vorher schlau zu machen, ist nen haufen Arbeit und ganz sicher etwas was man nicht 2 mal machen will ;)

Quote:

Originally Posted by dready Würd grundsätzlich sagen google mal ;) da findest alles recht detailiert So ganz ganz grundlegend kannst es etwa so machen 1. Was war das Ziel, wie hast du es umgesetzt, welche Ansätze sind schiefgegangen. 2. Deine Perspektive, was macht welche Funktion, welche Datenstrukturen gibt es, wie sind sie verknüpft 3. Endnutzer Perspektive, was können sie machen, wie können sie es machen. 4. Admin Perspektive der das ganze installieren muss, was für Voraussetzungen gibt es, worauf muss er achten. 5. Welche Testcases wurden gemacht, was waren die Ergebnisse. 6. Versions History, Was wurde wann, wie geändert. Würd dir aber wirklich ans Herz legen, dich vorher schlau zu machen, ist nen haufen Arbeit und ganz sicher etwas was man nicht 2 mal machen will ;)

Da ich erst heute mit der Umsetzung angefangen habe, ist noch nicht viel passiert, lediglich Migrations und einem Haufen von Testdaten für die Datenbank. Bisher hab ich z.B. die Datenbank Strukturen etc. alles grafisch dokumentiert, also in Form von Diagrammen. Würde man das auch mit in die Doku packen oder eher nicht?

Besteht noch Interesse? Bin noch einigermaßen fit, was Software-Architektur und Dokumentation angeht

Quote:

Originally Posted by NotThatBad Besteht noch Interesse? Bin noch einigermaßen fit, was Software-Architektur und Dokumentation angeht

Definitiv! Bisher ist das ganze nicht sonderlich ausgereift denke ich ˆˆ'