Berufsschule Software Dokumentation?
Hallo,
ich mache derzeit eine Ausbildung als Fachinformatiker für Systemintegration.
ich muss diese Woche eine Software Dokumentation erstellen diese nächste Woche in der Schule abgeben. Mit den Software bin ich schon fast durch. Ich habe aber einige Schwierigkeiten mit der Dokumentation.
wie ist so eine Dokumentation wirklich aufgebaut? Ich muss ein Zeitplan, ER-Modell und die Projektantrag einfügen. Wie mache ich das? Mache ich einfach ein Screenshot von den Zeitplan und füge sie hinzu?
die ganzen Dokumente sind PDF und ich muss die Doku in Word erstellen.
Uns wurde die Erstellung von einer Doku nicht richtig erklärt und das ist mein aller erstes Mal eine Doku zu erstellen. Falls jemand sich mit dem Thema auskennt, bitte melden,
danke im Voraus
2 Antworten
Uns wurde die Erstellung von einer Doku nicht richtig erklärt
Das kann man in einer Schule auch nur exemplarisch machen. Jeder Betrieb hat für die Dokumentationen sein eigenes Schema (oder sollte es zumindest haben), damit alle Dokumentationen des Betriebes unabhängig vom erstellenden Mitarbeiter gleich aufgebaut und von allen identisch gelesen werden können. Und für den Aufbau und die Struktur gibt es keine festgelegte Vorschrift, sondern höchstens Empfehlungen. Die Dokumentationen von zwei verschiedenen Betrieben sehen daher auch zumeist völlig unterschiedlich aus.
Lass dir deshalb im Betrieb zeigen, wie dort so eine Dokumentation aufgebaut ist.
Ja, genau so ist es.
Wie man dem Papier http://docplayer.org/9157885-Was-versteht-man-unter-softwaredokumentation.html entnehmen kann, ist die Frage nach guter Software-Dokumentation – u.A. auch die Frager nach Vollständigkeit solcher Dokumentation – kein Thema, von dem man verlangen könnte, dass ein Schüler es auch nur annähernd schon beherrschen könnte.
Du solltest dich also auf nur einen der vielen denkbaren Dokumentations-Aspekte konzentrieren und hierfür dann ein Beispiel geben, das überzeugt (d.h. einigermaßen aussagekräftig ist, was notwendiges Wissen über von dir betrachtete konkrete Software betrifft). Wähle dazu entweder das Datenmodell oder das Modell der Interaktion jener Software mit dem Benutzer.
Beispiele für ERD-Dokumentation finden sich z.B. ausgehend von Seite http://ERDNotation.htm