Zum Inhalt springen

Kontext des Projektes in der Einführung oder im Anhang erklären?

Empfohlene Beiträge

Hallo Leute,

Bei meinem Projekt handelt es sich um die Restrukturierung eines vorhandenen Features einer Altanwendung. Damit die Leser nun auch vollständig nachvollziehen können was ich mache und warum ich es gemacht habe, müssen sie wissen worum es sich bei meiner Anwendung handelt. Soll ich diesen Inhalt als Reiter "Kontext zum Projekt" in der Einleitung erklären oder den Kontext zum Projekt im Anhang erklären? Mir fällt das gerade sehr stark auf wenn ich eine Begründung für die Abweichung zum Projektantrag brauche und mir der nötige Kontext zum erklären fehlt.

Edit: Ich denke mir, dass ich einfach einen Unterabschnitt 1.2 Projektbschreibung und Kontext erstelle und das da eben erläutere. Wäre cool wenn ihr sagen könntet ob das okay ist.

Bearbeitet von MagProgrammierenNichtMal

Diesen Beitrag teilen


Link zum Beitrag
Auf anderen Seiten teilen
vor 15 Minuten schrieb Saheeda:

Ohne den notwendigen Hintergrund versteht man doch weder, was du gemacht hast, noch warum.

Das kann ich nur bestätigen! Unbedingt zu Beginn der Dokumentation alles zum Verständnis Notwendige erklären. Zur Not (wenn du im Fließtext zu wenig Platz hast) packst du es mit einer deutlichen Referenz in der Einleitung in den Anhang.

Und lass mal jemanden drüberlesen, der den Kontext nicht hat (also vielleicht einen unbeteiligten Kollegen oder noch besser einen betriebsfremden Mitschüler) und frag, ob die Inhalte verständlich sind.

Einer meiner Hauptkritikpunkte an Dokumentationen ist, dass das Thema unverständlich erklärt wird. Da frage ich mich teilweise noch nach dem Lesen der gesamten Doku, was überhaupt der Sinn des Projekts war.

Diesen Beitrag teilen


Link zum Beitrag
Auf anderen Seiten teilen

Das habe ich jetzt gemacht, jetzt fühlt es sich aber so an als würde in der Ist-Analyse so ziemlich das selbe drin stehen wie in der Projekt / Kontext Beschreibung + Projektziel. Wie muss ich jetzt da differenzieren und was gehört in den Kontext was nicht in die Ist-Analyse gehört? Oder ist das auch wieder abhängig vom Projekt?

Bearbeitet von MagProgrammierenNichtMal

Diesen Beitrag teilen


Link zum Beitrag
Auf anderen Seiten teilen

Deine Meinung

Du kannst jetzt schreiben und Dich später registrieren. Wenn Du ein Konto hast, melde Dich an , um mit Deinem Konto zu schreiben.

Gast
Auf dieses Thema antworten...

×   Du hast formatierten Text eingefügt.   Formatierung jetzt entfernen

  Nur 75 Emojis sind erlaubt.

×   Dein Link wurde automatisch eingebettet.   Einbetten rückgängig machen und als Link darstellen

×   Dein vorheriger Inhalt wurde wiederhergestellt.   Editor leeren

×   Du kannst Bilder nicht direkt einfügen. Lade Bilder hoch oder lade sie von einer URL.


Fachinformatiker.de, 2020 SE Internet Services

fidelogo_small.png

if_icon-6-mail-envelope-closed_314900.pnSchicken Sie uns eine Nachricht!

Fachinformatiker.de ist die größte IT-Community
rund um Ausbildung, Job, Weiterbildung für IT-Fachkräfte.

Fachinformatiker.de App


Get it on Google Play

Kontakt

Hier werben?
Oder senden Sie eine E-Mail an

Social media u. feeds

Jobboard für Fachinformatiker und IT-Fachkräfte

×
×
  • Neu erstellen...

Wichtige Information

Fachinformatiker.de verwendet Cookies. Mehr dazu in unserer Datenschutzerklärung