DIN-Normen bei Dokumentationen

[Tanthalas]

Hi alle,

hab mal eine Frage...und zwar hat unser Lehrer gesagt, dass es für die Abschlussprojektdokumentationen spezielle DIN-Normen für Zeilen-Abstände, Seiten-Abstände, Schriftgröße usw.

Habt Ihr auch schon was davon gehört und wenn ja, wo kann man diese einsehen?

tschoooooooß

Tanis

[P4tr!ck]

Ich dachte eigentlich das es von IHK zu IHK unterschiedlich ist und das dir Vorgaben in Handreichungen stehen oder bin ich jetzt vollkommen falsch informiert ?

[Tanthalas]

von unserer IHK wurden zwar Handreichungen ausgegeben, aber dort stehen nur Informationen wie: Deckblatt, persönliche Erklärung und Inhaltsverzeichnis drin, aber nicht wie genau die Formalitäten der Doku auszusehen hat.

Hab gehört, das die Schriftgröße zw. 10-12 sein muss, der Zeilen-Abstand zw. den Sätzen 1,5 beträgt, usw....

Aber das habe ich halt nur gehört, wollte aber gerne eine schriftliche Aufzählung....

werde mal weiter searchen....

[Andreas_Bot]

Hi alle,

hab mal eine Frage...und zwar hat unser Lehrer gesagt, dass es für die Abschlussprojektdokumentationen spezielle DIN-Normen für Zeilen-Abstände, Seiten-Abstände, Schriftgröße usw.

Habt Ihr auch schon was davon gehört und wenn ja, wo kann man diese einsehen?

tschoooooooß

Tanis

Moin,

habe jetzt keine Lust den ganzen Text zu formatieren -> ist von der IHK Mittelfranken (Nürnberg und Umgebung) - kannst du auch bei deiner IHK in Erfahrung bringen!

Die Dokumentation ist ausschließlich eine Projektbeschreibung und keine Produkt- oder Bedienungsanleitung

Kriterien zum Beurteilungs- und Bewertungsblatt

1 Projektdokumentation

1.1 Gesamtgestaltung:

1.1.1 Formale Gestaltung

Folgende Kriterien sollten zugrunde gelegt werden:

• Deckblatt mit Name, Projektbezeichnung, Ausbildungsbetrieb, Abgabedatum, Fachrichtung und das Jahr der Prüfung

• Kopf- und Fußzeile, darin enthalten der Name, Projektbezeichnung und die Ein-zelseitenanzahl der Gesamtzahl (z. B. 3 von 10)

• Der linke Rand sollte ca. 2 – 2,5 cm und der rechte Rand ca. 1,5 cm betragen

• Einheitliche Absatzformatierung Flattersatz oder Blocksatz mit Silbentrennung

• Einheitliche Abstände zur Überschrift und Kopfzeile

• Die Schriftgröße sollte 10 -12 sein, die verwendete Schriftgröße und die Schriftart sollten gut lesbar sein

• Der Zeilenabstand sollte mindestens einfach, höchstens jedoch 1,5 sein

• Als Format sollte Hochformat genommen werden (Zeichnungen u. Grafiken aus-genommen)

• Die optische Qualität der Dokumentation sollte der Bedeutung der Abschluss-prüfung angemessen sein. (Bindung, Druckqualität der Schriften und Grafiken)

• Inhaltsverzeichnis muss vorhanden sein und mit dem Inhalt übereinstimmen

• Sind Zitierregeln, Quellennachweise gekennzeichnet

1.1.2 Sprachliche Gestaltung:

Hier gelten folgende Maßstäbe bzw. auf folgende Fehler sollte geachtet werden:

• Wortwiederholungen

• Satzbildung, keine Schachtelsätze oder Worthülsen

• Keine Umgangssprache (z. B. da wo)

• Rechtschreibfehler, Grammatik und Zeichensetzungsfehler

• Wiederholungen von betrieblichen Abkürzungen sollten vorher mehrmals aus-geschrieben werden und im Abkürzungsverzeichnis aufgeführt sein

1.1.3 Vollständigkeit der Dokumentation angemessen

Darunter ist folgendes zu verstehen:

• Länge der Dokumentation sollte 20 Seiten nicht überschreiten (Doku und An-hang)

• Als Anhang gelten alle ergänzenden Unterlagen, die zur Dokumentation des Projektes gehören.

z. B. betriebliche Dokumentation, wie Kopien von Ausschreibungen, Formula-ren, Angebote, Serverparameter, Berechtigungen (Kennungen), Auszüge aus Quellcode, etc.

• Glossar

• Überprüfung und Bewertung der Zielereichung (Fazit)

1.2 Beschreibung / Konkretisierung des Auftrags

1.2.1 Verständlichkeit / Nachvollziehbarkeit des Auftrages:

• Die Nennung und Begründung des Projektziels.

• Was war der Grund für dieses Projekt (Motivation, Notwendigkeit des Auftrags)?

• Darstellung des Projektumfelds, z. B. durch eine Beschreibung des Arbeitsbe-reichs oder des tägl. Arbeitsgebietes (technische Umgebung) in der das Projekt stattfindet

• Hinweis auf den Auftraggeber (intern / extern)

• Weicht der Auftrag gegenüber dem Projektantrag ab?

• Ist der Auftrag zu Beginn der Dokumentation aufgeführt und vom Prüfling klar abgegrenzt?

1.2.2 Angemessene Darstellung der relevanten Einflussfaktoren

• Beschreibung der Ausgangslage

• Beschreibung der Schnittstellen des Projekts (Personen, Abteilungen, Hard- und Software, etc.)

• Darstellung von Abhängigkeiten und Einflussfaktoren, die den Erfolg des Projek-tes mitbestimmen. Stehen die Kosten, oder eine perfekte Lösung im Vorder-grund?

• Welche Ressourcen stehen zur Verfügung und wie werden sie genutzt?

Um als Korrektor die Frage zu beantworten, wann der Punkt 1.2. vollständig abgehandelt wurde, sollte man sich vielleicht an folgenden Leitfragen orientieren:

- Ist mir die Ausgangslage des Projektes klar?

- Ist das Projektziel klar?

- Verstehe ich, in welchem Umfeld das Projekt stattfindet?

- Hat sich der Prüfling Gedanken gemacht, wovon der Erfolg seines Projektes ab-hängt und diese dokumentiert?

1.3 Beschreibung der Projektschritte und der Ergebnisse

1.3.1 Nachvollziehbarkeit der Projektschritte

• Ist eine Überlegung der Vorgehensweise und eine Projektplanung vorhanden

• Sind die einzelnen Projektschritte folgerichtig und die Vorgehensweise nachvoll-ziehbar dargestellt.

• Sind alle Projektschritte vorhanden und von wem wurden sie ausgeführt. (nach IT-Handbuch)

• Ist die Beschreibung ausreichend, dass ein fachkundiger Dritter ggf. die Projekt-schritte durchführen könnte?

• Das Projekt muss ohne Verweis auf den Anhang nachvollziehbar sein.

1.3.2 Plausible Begründung der Projektschritte

• Sind die einzelnen Projektschritte begründet und deren Ergebnisse dargestellt?

1.3.3 Plausibilität des Zeitaufwandes für die Projektschritte

• Gibt es eine Auflistung des real erbrachten Zeitaufwandes für jeden Projekt-schritt mit detaillierter Tätigkeitsbeschreibung und ist die Zeitangabe plausibel begründet.

• Werden Abweichungen zwischen geplantem und realisiertem Zeitaufwand be-gründet?

• Zeitabweichungen sind jederzeit möglich (nach oben und unten),

sie müssen jedoch begründet sein

• Der Zeitaufwand für die Erstellung der Projektdokumentation ist nur für die Roh-daten verbindlich, nicht für Formatierung und Ausformulierung

[Tanthalas]

Das ist doch mal ein klare Aussage!

Die Manege dankt!!!

tschoooooooooß

Tanis

[IJK]

@Tanthalas

Zur Sicherheit: Das oben getextete gilt für die IHK Mittelfranken (Nürnberg und Umgebung). Bereits bei mir in München gelten andere Regeln. Woimmer du bist, wende dich persönlich an deine IHK. Echte "Normen" gibt es deshalb nicht, da die Doku eigentlich im CI/CD deiner Firma erstellt werden soll und kann.

Aber trotzdem: Was da oben steht ist erst mal als grober Rahmen nicht schlecht...