Projektdokumentation wie schreiben

[Alexi29]

Hallo liebe Community,
Ich habe eine Frage zu der Projektdokumentation, ich bin FAEI. Also sollte man die Projektdokumentation schreiben dass es jeder verstehen kann, also nicht zu technisch? Oder sollte man es technisch schreiben?
Beim Punkt Implementierung (Prozesse) sollte man dort ein paar Schritte aufschreiben wie man programmiert hat (mit welchen Befehlen,Funktionen) oder was sollte man dort genau schreiben?
Ich hoffe meine Fragen sind verständlich. Ich bin bei die IHK in Stuttgart
Vielen dank im Voraus für eure Antworten

[charmanta]

Hast Du von der Berufsschule keine Muster einsehen können ?

Wer ist lt. Deiner IHK Zielgruppe des Projekts und der Doku ?

Inhaltlich "schwer" technische Dinge kommen üblicherweise in den Anhang, genauso Code

Mal wieder aus der Prüfungsordnung:

(2) Der Prüfling soll in Teil A der Prüfung eine betriebliche Projektarbeit durchführen und dokumentieren
sowie in insgesamt höchstens 30 Minuten diese Projektarbeit präsentieren und
darüber ein Fachgespräch führen. Für die Projektarbeit soll der Prüfling einen Auftrag oder
einen abgegrenzten Teilauftrag ausführen. Hierfür kommt insbesondere eine der nachfolgenden
Aufgaben in Betracht:
1. in der Fachrichtung Anwendungsentwicklung in insgesamt höchstens 70 Stunden für die
Projektarbeit einschließlich Dokumentation:
a) Erstellen oder Anpassen eines Softwareproduktes, einschließlich Planung, Kalkulation,
Realisation und Testen,
b) Entwickeln eines Pflichtenheftes, einschließlich Analyse kundenspezifischer Anforderungen,
Schnittstellenbetrachtung und Planung der Einführung;

 

Die Ausführung der Projektarbeit wird mit praxisbezogenen Unterlagen dokumentiert. Durch
die Projektarbeit und deren Dokumentation soll der Prüfling belegen, daß er Arbeitsabläufe
und Teilaufgaben zielorientiert unter Beachtung wirtschaftlicher, technischer, organisatorischer
und zeitlicher Vorgaben selbständig planen und kundengerecht umsetzen sowie Dokumentationen
kundengerecht anfertigen, zusammenstellen und modifizieren kann. Durch die
Präsentation einschließlich Fachgespräch soll der Prüfling zeigen, daß er fachbezogene Probleme
und Lösungskonzepte zielgruppengerecht darstellen, den für die Projektarbeit relevanten
fachlichen Hintergrund aufzeigen sowie die Vorgehensweise im Projekt begründen kann.
Dem Prüfungsausschuß ist vor der Durchführung der Projektarbeit das zu realisierende Konzept
einschließlich einer Zeitplanung sowie der Hilfsmittel zur Präsentation zur Genehmigung
vorzulegen

 

EDIT: Schau mal hier, hier findest Du Musterarbeiten ;)

https://fachinformatiker-anwendungsentwicklung.net/tag/projektdokumentation/

 

[Alexi29]

Danke für deine Antwort Charisma, aber die Prüfungsordnung hilft in meinem Fragen nicht weiter.
Die Zielgrupper wird der Kunde mit höher Warscheinlichkeit sein in der Präsentation.
Danke für den Link, ich habe mir schon mal ein paar Beispiele angeschaut.
Soweit ich dass verstanden haben sollte man die Projektdokumentation eher normal schreiben also nicht zu technisch, so dass es jemand auch ohne IT-Wissen lesen und verstehen kann . Ist das korrekt?
Leider habe ich noch keine Antwort für die zweite Frage erhalten.
Vielen dank im Voraus für eure Antworten, und für die Hilfe.
 

[stefan.macke]

vor 3 Stunden schrieb Alexi29:

Soweit ich dass verstanden haben sollte man die Projektdokumentation eher normal schreiben also nicht zu technisch, so dass es jemand auch ohne IT-Wissen lesen und verstehen kann . Ist das korrekt?

Nein. Du wirst von Informatikern im Beruf des Informatikers geprüft. Du musst sogar sehr technisch werden. Und natürlich auch kaufmännisch.

Du musst nur darauf achten, dass man als unternehmensfremder Leser dein Projektthema versteht. Technisch kannst (und sollst) du richtig vom Leder ziehen!

[Alexi29]

@stefan.macke Danke sehr für deine Antwort, ich verstehe, aber man sollte es schon leichter schreiben oder? Wie ich schon sagte die Beispiele von der Seite zeigen, dass man es  sehr ausführlich schreibt, so dass es jemand verstehen kann, der auch nicht Informatiker/Programmierer ist, oder sehe ich falsch?
Ich schreibe noch meine zweite Frage auf: "Beim Punkt Implementierung (Prozesse) sollte man dort ein paar Schritte aufschreiben wie man programmiert hat (mit welchen Befehlen, Funktionen) oder was sollte man dort genau schreiben?"
Vielen dank für eure Hilfe.

 

[Alexi29]

Hallo Leute, ich melde mich nochmal, ich freue mich auf eure Antworten/Hilfe schon im Voraus.
Ich habe noch eine Frage: Wenn ich im Unternehen mich noch nie mit Test-Unit beschäft habe, nur den Quellcode zu debugen. Wie kann man so etwas in der Projektdokumentation argumentieren?
Danke für eure Antwort seht euch bitte auch die 2 Frage in meinem vorherigen Beitrag an.

[Alexi29]

Leider habe seit letzte Woche keine Antwort erhalten. Ich verstehe dass ihr es alle freiwillig macht in Forum hier zu sein.
Wenn jemand Zeit hat wäre ich sehr froh, dass er auf meine Fragen Antworten. Oder sind meine Fragen nicht verständlich? Dann könnt ihr gerne Rückfragen stellen.
Vielen Dank im voraus Leute.

Bearbeitet 26. November 2019 von Alexi29

[stefan.macke]

Am 18.11.2019 um 00:24 schrieb Alexi29:

@stefan.macke Danke sehr für deine Antwort, ich verstehe, aber man sollte es schon leichter schreiben oder? Wie ich schon sagte die Beispiele von der Seite zeigen, dass man es  sehr ausführlich schreibt, so dass es jemand verstehen kann, der auch nicht Informatiker/Programmierer ist, oder sehe ich falsch?

Hast du meine obige Antwort eigentlich gelesen? Ich habe das exakte Gegenteil geschrieben. Du musst mir (und deinen Prüfern) nicht erklären, was eine for-Schleife ist.

Am 18.11.2019 um 00:24 schrieb Alexi29:

Ich schreibe noch meine zweite Frage auf: "Beim Punkt Implementierung (Prozesse) sollte man dort ein paar Schritte aufschreiben wie man programmiert hat (mit welchen Befehlen, Funktionen) oder was sollte man dort genau schreiben?"

Implementierung = Programmierung. Also ja. Auch hier wieder: niemand will von dir ein if-Statement erläutert haben. Es geht ums große Ganze.

Der Entwicklungsprozess könnte aber auch gemeint sein. Beides Dinge, die ich in einer Projektdokumentation erwarte.

[Alexi29]

@stefan.macke Danke für deine Antwort, ich haben verstanden. Ich habe noch eine letzte Frage: Wenn ich im der Firma mich noch nie mit Test-Unit beschäftigt habe, nur den Quellcode  debuggen, damit ich sehe ob Fehler auftreten, oder ob das Programm läuft. Wie kann man so etwas in der Projektdokumentation argumentieren?

[Visar]

vor 4 Minuten schrieb Alexi29:

Wie kann man so etwas in der Projektdokumentation argumentieren?

Eigentlich gar nicht. Das beschriebene Vorgehen würde ich heutzutage als "bad practice" bezeichnen. Denn der Umstand, dass das Programm lauffähig ist sagt erstmal nichts darüber aus, ob es auch richtig funktioniert.  Deswegen gibt es Tests, um jeden Anwendungsfall idealerweise automatisiert zu testen und anschließend zu debuggen, sofern erforderlich (sprich: wenn Fehler auftreten).