30 Seiten technische Doku? :|

[Der Grieche]

Wie schlimm ist es? Ich habe die Bilder verkleinert (bis zur Größe, dass sie noch "lesbar" sind) und versucht nur die wichtigste Bilder hinzufügen. Trotzdem komme ich auf 30 Seiten 😐

Meine technische Doku ist eine Schritt-für-Schritt Anleitung für die Administratoren des Kunden und hat kaum Text.

 

Noch ein paar Fragen:

Der IHK braucht physische 2-Kopien. Sie sollten per Post zugeschickt werden.

Beide Kopien in einem Umschlag?

Muss ich auch die Anhänge die mit der Doku nichts zu tun haben auch ausdrucken und schicken? (45-50 Seiten Doku und Anhänge)

Wäre es schlimm wenn ich 90-100gsm Blätter nutze?

Ist es wichtig, ob es Farbig oder Schwarz/Weiß ist?

Was gehört noch am Ende der Doku außer die Folgenden und in welche Reihe?:

- Anhang (Bilder, Tabellen. Alle Verzeichnisse sind am Anfang der Doku)

- Eidesstattliche Erklärung

- Projektantrag

- technische Doku

- ?

[Visar]

vor 8 Minuten schrieb Der Grieche:

Wie schlimm ist es?

Das hängt von der Prüfungsordnung deiner IHK ab, ob im Projektantrag irgendetwas spezifiziert wurde und so weiter und so fort.

Wie sollen wir das, ohne weitere Informationen, beurteilen können?

vor 8 Minuten schrieb Der Grieche:

Meine technische Doku ist eine Schritt-für-Schritt Anleitung für die Administratoren des Kunden und hat kaum Text.

Du hast eine Dokumentation erstellt, die im Prinzip nur aus Bildern besteht? Das klingt nicht richtig. Wie vermittelst du deine (kaufmännischen) Entscheidungen, mit Pfeilern auf den Bildern oder Haken und Kreuzen für Ja oder Nein?

vor 8 Minuten schrieb Der Grieche:

Muss ich auch die Anhänge die mit der Doku nichts zu tun haben auch ausdrucken und schicken? (45-50 Seiten Doku und Anhänge)

Du hast Anhänge, die mit der Dokumentation bzw. deinem Projekt nichts zu tun haben?

Dann sollten sie in der Dokumentation auch nicht enthalten sein. Oder im Anhang.

vor 8 Minuten schrieb Der Grieche:

Wäre es schlimm wenn ich 90-100gsm Blätter nutze?

Ist es wichtig, ob es Farbig oder Schwarz/Weiß ist?

Was gehört noch am Ende der Doku außer die Folgenden und in welche Reihe?:

- Anhang (Bilder, Tabellen. Alle Verzeichnisse sind am Anfang der Doku)

- Eidesstattliche Erklärung

- Projektantrag

- technische Doku

Guckst du bitte in Prüfungsordnung, in der stehen sollte, in welcher Form die IHK das idealerweise haben möchte?

Bearbeitet 31. März 2020 von Visar

[Der Grieche]

vor einer Stunde schrieb Visar:

Das hängt von der Prüfungsordnung deiner IHK ab, ob im Projektantrag irgendetwas spezifiziert wurde und so weiter und so fort.

Wie sollen wir das, ohne weitere Informationen, beurteilen können?

Es wurde nichts im Antrag angegeben.

vor einer Stunde schrieb Visar:

Du hast eine Dokumentation erstellt, die im Prinzip nur aus Bildern besteht? Das klingt nicht richtig. Wie vermittelst du deine (kaufmännischen) Entscheidungen, mit Pfeilern auf den Bildern oder Haken und Kreuzen für Ja oder Nein?

Die technische Dokumentation (Kundendokumentation) besteht fast nur aus Bilder. Die Hauptdokumentation besteht nur aus Text und alle Bildern sind im Anhang.

vor einer Stunde schrieb Visar:

Du hast Anhänge, die mit der Dokumentation bzw. deinem Projekt nichts zu tun haben?

Nein. Alle haben was mit der Doku zu tun. Ich meinte Anhänge wie die Eidesstattliche Erklärung, der Projektantrag und die technische Doku (sie wird nicht bewertet)

vor einer Stunde schrieb Visar:

Guckst du bitte in Prüfungsordnung, in der stehen sollte, in welcher Form die IHK das idealerweise haben möchte?

Da steht's nur: 
 

Inhalte der Dokumentation sind:
 Name und Ausbildungsberuf des Prüfungsteilnehmers
 Angabe des Ausbildungsbetriebes/Prüfbetriebes
 Thema der Projektarbeit
 Falls erforderlich, Beschreibung/Konkretisierung des Auftrages
 Umfassende Beschreibung der Prozessschritte und der erzielten Ergebnisse
 Gegebenenfalls Veränderungen zum Projektantrag mit Begründung
 Wenn für das Projekt erforderlich, ein Anhang mit praxisbezogenen Unterlagen und
Dokumenten. Dieser Anhang sollte nicht aufgebläht werden. Die angehängten
Dokumente und Unterlagen sind auf das absolute Minimum zu beschränken.

Also der letzte Punkt ist wichtig...aber will soll ich es denn machen? Mehr mit Text beschreiben und weniger Bilder nutzen?

Bearbeitet 31. März 2020 von Der Grieche

[_n4p_]

Also besteht deine technische Doku aus Bildern auf denen auf "Weiter" geklickt wurde? Das ist jetzt etwas das ich anderen durchaus zutraue ohne ihnen ein Bild zu malen. Bilder würde ich auch hier sparsam einsetzen und damit zeigen wie "komplexere Formulare" befüllt werden müssen, den Rest würde ich lediglich beschreiben. Ist dies nicht sinnvoll umzusetzen, weil beispielsweise die Installation aus 30 Formularen mit Untermenüs besteht, würde ich die Bilder in eine Präsentation packen und von der Doku darauf verweisen.

In die technische Doku gehört meiner Meinung nach auch weniger die Installation, die ist ja schon passiert, sondern der Umgang mit dem System. Also Wo ist das System, wie kann ich darauf zugreifen, wie kann ich Aufgabe X mit dem System lösen, wo sind die Backups, was passiert wenn das System kaputt ist, ... 

[Der Grieche]

vor 10 Minuten schrieb _n4p_:

Also besteht deine technische Doku aus Bildern auf denen auf "Weiter" geklickt wurde? Das ist jetzt etwas das ich anderen durchaus zutraue ohne ihnen ein Bild zu malen. Bilder würde ich auch hier sparsam einsetzen und damit zeigen wie "komplexere Formulare" befüllt werden müssen, den Rest würde ich lediglich beschreiben.

Mmmmm...nicht ganz. Wenn man einfach "Next" drucken sollte, habe ich geschrieben: "Für die nächste Schritte werden die Standardeinstellung beibehalten" und dann direkt den nächsten wichtigen Punkt bzw. Schritt aufgezeigt.

 

vor 11 Minuten schrieb _n4p_:

In die technische Doku gehört meiner Meinung nach auch weniger die Installation, die ist ja schon passiert, sondern der Umgang mit dem System. Also Wo ist das System, wie kann ich darauf zugreifen, wie kann ich Aufgabe X mit dem System lösen, wo sind die Backups, was passiert wenn das System kaputt ist, ... 

Genau das. "Wartung und Verwaltung des Systems" war meine Idee, aber der Projektbetreuer wollte, dass ich eine technische Dokumentation im Bezug auf der Installation und dem Aufbau schreiben sollte.

[_n4p_]

Naja dann ist das halt so, solang deine reine Projektdoku die Vorgabe deiner IHK nicht übersteigt ist alles grün. Anhang zählt normalerweise nicht zu den Seiten dazu.