Richtlinie für wissenschaftliche und studentische Arbeiten

Inhaltsverzeichnis

    1. 1 Schriftliche Ausarbeitung
      1. 1.1 Allgemeines
      2. 1.2. Zum allgemeinen Aufbau der Arbeit
      3. 1.3 Form der Arbeit
    2. 2 Anzahl der Exemplare
    3. 3 Abgabe der Arbeit
      1. Studienarbeiten
      2. Diplomarbeiten
    4. 4 Kurzfassung und Abstract
    5. 5 Poster (nur Diplomarbeit)
    6. 6 Verteidigung
    7. Anhang
      1. Anhang 1: Vorlagen zur Anfertigung einer studentischen Arbeit
      2. Anhang 2: Postergestaltung
      3. Anhang 3: Informationsmittel zur Literaturrecherche
      4. Anhang 4: Hilfestellung zum wissenschaftlichen Schreiben
      5. Anhang 5: Spezielle Anforderungen an Installationsanleitung und Portierungsanleitung für Software
      6. 5.1 Installationsanleitung
      7. 5.2 Portierungsanleitung
      8. 5.3 Beschreibung der erforderlichen Konfiguration der Rechnerplattform

1 Schriftliche Ausarbeitung

1.1 Allgemeines

Voraussetzung für den Beginn der Arbeit ist eine gültige und bestätigte Aufgabenstellung.  Diplomthemen müssen vom Prüfungsamt der Fakultät Elektrotechnik und Informationstechnik bestätigt und unterschrieben vorliegen !

Die Arbeit ist ohne Verzicht auf Vollständigkeit kurz zu fassen. Der schriftliche Bericht soll dem Stand von Wissenschaft und Technik auf dem speziellen Gebiet entsprechen und die Durchführung der Aufgabe, die mit ihr verknüpften theoretischen und experimentellen Untersuchungen, ihre Ergebnisse und Schlussfolgerungen eindeutig und klar erkennen lassen. Jeder Teilabschnitt soll dem Lesenden Ergebnisse vermitteln, die er an einer anderen Stelle nicht oder zumindest nicht mit vergleichbar geringem Zeitaufwand findet. Es kommt darauf an, das Wesentliche der eigenen Arbeitsergebnisse entsprechend ihrem wissenschaftlichen Charakter klar, prägnant und einfach darzustellen. Ratsam ist es, am Schluss von größeren Abschnitten oder Teilproblemen die Ergebnisse gesondert zusammenzufassen.
Zum Anfertigen der Diplomarbeit ist es empfehlenswert, die dafür vom IfA bereitgestellte LaTeX-Vorlage (siehe Anhang 1) zu verwenden. In dieser Vorlage enthalten ist eine Layout-Beispiel-PDF-Datei ("example_print.pdf"). Bei Verwendung anderer Software (OpenOffice, Word, etc.) zur Erstellung der Arbeit ist deren Layout an dieses Layout-Beispiel anzupassen.

Beim Verfassen einer Arbeit ist besonderes Augenmerk auf die einschlägigen Richtlinien der wissenschaftlichen Praxis zu legen. Diese umfassen unter anderem auch die korrekte Kenntlichmachung der Verwendung von Arbeiten Dritter (siehe auch Literaturstellen oder Zitieren). Dieses Erfordernis entspringt dem deutschen Urheberrechtsgesetz (UrhG). Das Nicht-Einhalten (Plagiat) kann die Nicht-Annahme der studentischen Arbeit und infolge dessen das Nicht-Bestehen der Prüfungsleistung zur Folge haben. Des Weiteren ergeben sich etwaige Ansprüche Dritter gegenüber der Autoren einer studentischen Arbeit aus dem UrhG. Der betreuende Hochschullehrer hat das Recht, die studentische Arbeit in begründeten Verdachtsfällen einer Plagiatsprüfung durch die "Prüfstelle gegen wissenschaftliches Fehlverhalten der TUD" zu unterziehen. Ein Nachweis von Plagiaten kann zur Zurückziehung der Arbeit und nachträglichen Aberkennung des akademischen Grades führen.

Eine Handreichung zum Zitieren in studentischen Arbeiten finden Sie HIER.

Eine Richtlinie wichtiger Inhalte von Studien- und Diplomarbeiten finden Sie HIER.

1.2. Zum allgemeinen Aufbau der Arbeit

Reihenfolge

  • Titelblatt
  • Aufgabenstellung im Original (vom verantw. Hochschullehrer unterschrieben)
  • Kurzfassung (deutsch)
  • Abstract (englisch)
  • Inhaltsverzeichnis
  • Einleitung (Motivation, Einordnung der Aufgabenstellung)
  • Grundlagen und Stand der Technik
  • Anforderungsdefinition
    • Konkretisieren der Aufgabenstellung durch Nutzeranforderungen, Formulieren z.B. nach IEEE 
    • Systemanforderungen
      Dekomposition nach strukturierter Analyse oder UML
  • Variantendiskussion
    • Diskussion unterschiedlicher Realisierungsvarianten für die spezifizierten Teilfunktionen oder Anwendungsfälle
  • Entwurf
  • Implementierung
  • Validierung
    • Nachweis, dass Produkt den Nutzeranforderungen entspricht
  • Diskussion/Zusammenfassung/Ausblick
    • zusammenfassende Darstellung des Entwicklungsprozesses
    • Diskussion von Ergebnissen und Erfahrungen
    • Darstellung von Defiziten - Anregungen für folgende Arbeiten
  • Anhänge
    • Anlagenverzeichnis
    • Anhänge 1...n
  • Literaturverzeichnis
  • Selbstständigkeitserklärung.

Nachfolgende Anmerkungen erläutern die Anstriche.

Titelblatt

Als Titelblatt sind folgende Vorlagen zu verwenden:

Textteil

Der Textteil ist in dezimalklassifizierter Weise zu nummerieren. Die Gliederungstiefe sollte 4 Gliederungsebenen nicht übersteigen. Das Inhaltsverzeichnis erhält keine Gliederungsnummer; die Einleitung ist der erste Gliederungsabschnitt (1 Einleitung). Die Einleitung beginnt auf einer neuen Seite.
Das Inhaltsverzeichnis beginnt auf einer neuen Seite. Das Wort "Inhaltsverzeichnis" ist als Überschrift zu schreiben. Das Verzeichnis muss die Abschnittsnummern, die Abschnittsüberschriften wie im Text sowie die jeweilige Seitenzahl (Beginn des Abschnittes) enthalten.
Das Inhaltsverzeichnis nennt nicht die Titelseite, die Aufgabenstellung, das Inhaltsverzeichnis selbst und die Selbständigkeitserklärung.

Die Einleitung sollte folgende wesentliche Aussagen vermitteln:

  • Einordnung in das Wissensgebiet
  • Motivation für die Arbeit, Darstellung von Zusammenhängen, die zur Formulierung der Aufgabe geführt haben
  • Präzisierung der Aufgabenstellung, Vorgehensweise zur Problemlösung.

Im ausführenden Textteil (aufgabenabhängig unterschiedlich viele Abschnitte) sind theoretische Grundlagen, Lösungsansätze mit Bewertung möglicher Lösungswege, ausgeführte Lösungen, Funktionsnachweise mit vollständiger Beschreibung der Test- und Untersuchungsbedingungen darzustellen.
Der Umgang mit Bildern, Tabellen, Gleichungen und Literaturstellen ist im Abschnitt 1.3 genauer erläutert.
In der Zusammenfassung sind die wesentlichen Inhalte und Ergebnisse der Arbeit in übersichtlicher Form zusammenzufassen und einer Wertung zu unterziehen. Gegebenenfalls sollte auf offene Probleme hingewiesen werden.
Am Beginn der Arbeit ist der Stand der Wissenschaft und Technik aufgabenbezogen darzustellen. Darüber hinaus muss in der gesamten schriftlichen Arbeit eine klare Abgrenzung des eigenen Beitrags von genutzten Vor- und Parallelarbeiten erfolgen. Dazu ist insbesondere die verwendete Literatur in einem Literaturverzeichnis zu zitieren.

Anhänge

Als Anhang der wissenschaftlichen Arbeit sind solche Teile zu deklarieren, die wegen ihres großen Umfanges den Textteil der Arbeit sprengen würden, zum Verständnis aber notwendig sind. Typische Inhalt von Anhängen sind Versuchsprotokolle, Simulationsprotokolle, detaillierte Darstellung technischer Realisierungen und Programmausdrucke.
Bei mehreren Anhängen ist ein Verzeichnis der Anhänge voranzustellen.

Achtung! Bei der Abgabe von Software müssen folgende Anleitungen elektronisch auf CD abgegeben werden: vollständige Installationsanleitung und vollständige Portierungsanleitung für die Software (siehe spezielle Anforderungen in Anhang 5).

Selbstständigkeitserklärung

Zur Bestätigung der selbstständigen Anfertigung der Arbeit ist das entsprechende Muster Selbstständigkeitserklärung  (docx-file) zu verwenden.

1.3 Form der Arbeit

Studienarbeiten und Diplomarbeiten sind im Format DIN A 4 vorzulegen. Größere Blätter, z.B. Zeichnungen, sind auf dieses Format zu falten. Materialien in kleinerem Format sind auf Blätter vom Format DIN A4 aufzukleben oder in Taschen einzustecken. Nicht faltbare Materialien größer als DIN A4 sind als Band getrennt beizufügen.

Seitenzählung

 Titelblatt  keine
 Aufgabenstellung  keine
 Kurzfassung (deutsch)  keine
 Abstract (englisch)  keine
 Inhaltsverzeichnis  keine
 Hauptteil beginnend mit Einleitung  Nummerierung mit arabischen Ziffern beginnend mit 1
 Anhänge  gesonderte Nummerierung empfohlen
 Literaturverzeichnis  keine
 Selbstständigkeitserklärung  keine

Bilder und Tabellen

Als Bilder sind Fotos, Zeichnungen, Diagramme, Schemata u.a. zu benennen. Tabellen sind Übersichten, Aufzählungen, Gegenüberstellungen in numerischer oder textueller Form. Eine abschnittsweise Nummerierung ist empfehlenswert.
Bilder sind mit Bildunterschriften zu versehen (Bezeichnung "Bild", lfd. Nr., aussagefähige Bezeichnung; z.B. Bild 3.1: Strecke mit PID-Regler).
Tabellen erhalten eine Tabellenüberschrift (Bezeichnung "Tabelle", lfd. Nr., aussagefähige Bezeichnung; z.B. Tabelle 3.1: Aufwand bei Programmentwicklung).

Gleichungen

Gleichungen sind entsprechend DIN 1338 (Formelschreibweise und Formelsatz) zu gestalten. Sie sind im Text fortlaufend zu nummerieren und mit runden Klammern am rechten Rand zu kennzeichnen. Eine abschnittsweise Nummerierung ist zu empfehlen. Gleichungen sind in den durchgängig lesbaren Text der Arbeit unter Beachtung von Interpunktionszeichen einzubeziehen. Formelzeichen sind zu erklären. Der Verweis auf eine oder mehrere Gleichungen ist im Text mit der Abkürzung Gl. () bzw. Gln. () zu beschreiben.

Beispiel

... so erhält man unter Einbeziehung von Gl. (3.2) und der Gln. (3.8) bis (3.10) schließlich den Zusammenhang:

                                       (3.11)

wobei a.... bedeutet.

Bei der Wahl der Formelzeichen ist zu beachten, dass der Bezeichner "Ta" in mathematischer Schreibweise "T·a" bedeutet. Deshalb ist in Formeln eine tiefgestellte Indizierung (Ta) zu bevorzugen. Sollen im Zusammenhang mit Rechenprogrammen gleichungsmäßige Zusammenhänge erläutert werden, so sind geeignete Indizes zu wählen (z.B. Ta) oder besondere Anmerkungen zu treffen.

Literaturstellen

Arbeiten und Erkenntnisse Dritter sind in der schriftlichen Arbeit eindeutig von eigenen Arbeiten abzugrenzen und durch geeignete Zitierung zu belegen. Die Vorgaben zur Zitierung sind in der >>Handreichung zum Zitieren in studentischen Arbeiten<< nachzulesen.
!!! ACHTUNG: Fehlendes Kenntlichmachen von Zitaten kann zur Nichtannahme einer wissenschaftlichen Arbeit führen !!!

Mögliche Ordnungsprinzipien im Literaturverzeichnis sind

  • numerische Ordnung in alphabetischer Reihenfolge nach jeweils erstem Autor
  • numerische Ordnung nach der Reihenfolge der zitierten Quellen
  • alphabetische Ordnung

Literaturangaben sind in der Vollständigkeit und Interpunktion gemäß nachfolgender Beispiele (Buch, Zeitschrift, Tagungsband, Firmenschrift, Diplomarbeit, Standard, Internetquelle) auszuführen:

 [1]  Isermann, R.: Identifikation dynamischer Systeme, Band II.
Springer-Verlag, Berlin, Heidelberg, New York, 1988.
 [2] Bärmann, F.;  Greye, G.R.; Lüdeke, M.: Prozessregelung einer Nachreaktion auf der Basis eines
künstlichen neuronalen Netzmodells. Automatisierungstechnische Praxis 37 (1995) 8, 36-43.
 [3] Pereira, C.;  Rathke, T.: Objektorientierte Entwicklung von Echtzeitsystemen in der
Automatisierungstechnik. Proc. 39. Int. Wiss. Kolloq., Ilmenau 1994.
 [4] National Instruments Corp.: LabView-Getting Started with LabView for Windows.
Software-Dokumentation, 1992.
 [5] Nitsche, R.: Entwurf und Erprobung eines Fuzzy-Reglers zur Reibkraftkompensation.
Diplomarbeit FH Heilbronn, Feb. 1993.
 [6] DIN 19227, Teil 2: Graphische Symbole und Kennbuchstaben für die Prozessleittechnik,
Darstellung und Einzelheiten.

Alternativ kann auch die sog. Harvard-Nummerierung verwendet werden. Dabei wird ein Kürzel aus drei Buchstaben (des einzigen bzw. der ersten drei Autoren) und zwei Ziffern des Erscheinungsjahres gebildet.

Beispiele

 [Bra-95] Branicky, M.S.: Studies in hybrid systems: Modeling, analysis and control.
Diss. Massachusetts Institute of Technology, Cambridge 1995.
 [Büh-88] Bühler, H.: Anti-Reset-Windup-Maßnahmen bei stetigen Reglern.
at - Automatisierungstechnik 36 (1988) 5, 190-191.
 [CEO-93] Cellier, F.E.; Elmqvist, H.; Otter, M. u.a.: Guidelines for Modeling and Simulation
of Hybrid Systems. IFAC World Congress. Sydney 1993, 1219-1225.
 [Eng-97] Engell, S.: Modellierung und Analyse hybrider dynamischer Systeme.
at - Automatisierungstechnik 45 (1997) 4, 152-161.
 [Fil-60] Filippov, A.F.: Differential equation with discontinuous right-hand sides.
Mathematicheskii Sbornik 51 (1960).
 [SSc-00] Schaft, A.v.d.; Schumacher, H.: An introduction to hybrid dynamic systems. (Lecture
notes in control and information Science 251) London, Berlin, Heidelberg (Springer) 2000.
 [TWM-00] Thiele, W.; Wildner, K.; Matschiner, H. u.a.: Offenlegungsschrift OS DE 198 50 530 A.
Kreislaufverfahren zum Beizen von Kupfer und Kupferlegierungen (2000).
 [ZUt-96] Zhao, F.; Utkin V.: Adaptive Simulation and Control of Variable-structure Control
Systems in Sliding Regimes. Automatica 32 (1996) 7, 1037-1042.

2 Anzahl der Exemplare

Für die Herstellung der Originale, Kopien und CD ist der Bearbeitende verantwortlich.  Wenn durch den betreuenden Hochschullehrer nicht anders festgelegt, ist die nachfolgend genannte Anzahl von Exemplaren abzugeben.

Studienarbeiten

  • 2 Exemplare (gedruckt): Die Bindung hat so zu erfolgen, dass ein nachträglicher Austausch von Seiten nicht möglich ist (was eine Spiralbindung ausschließt).
  • 1 CD (mit elektronisch lesbarer Form der Studienarbeit, der Kurzfassung, des Abstracts, den verwendeten Bildern sowie zur Arbeit gehörendem Programm- und Daten-Files, der Installationsanleitung und der Portierungsanleitung für die Software)
  • Kurzfassung und Abstract (jeweils ein gedrucktes Exemplar)

 Diplomarbeiten

  • 2 Exemplare (gedruckt): Die Bindung hat so zu erfolgen, dass ein nachträglicher Austausch von Seiten nicht möglich ist (was eine Spiralbindung ausschließt).
  • 1 CD (mit elektronisch lesbarer Form der Diplomarbeit, der Kurzfassung, des Abstracts, den verwendeten Bildern sowie zur Arbeit gehörenden Programm- und Daten-Files, der Installationsanleitung und der Portierungsanleitung für die Software)
  • Kurzfassung und Abstract (jeweils ein gedrucktes Exemplar)
  • Poster (zur Verteidigung)

3 Abgabe der Arbeit

Studienarbeiten

Gilt nur für PLT/Urbas:

  • Der Studierende legt dem Betreuer/verantw. Hochschullehrer termingerecht zwei Exemplare der Studienarbeit zur Bestätigung der Vollständigkeit vor (Signum und Datum auf Deckblatt).
  • Der Studierende gibt anschließend beide Exemplare im PLT-Sekretariat ab und erhält den Laufzettel.
  • Das Sekretariat übergibt die Exemplare an den Betreuer zur Weiterleitung an die Gutachter.
  • Nach Erhalt des Laufzettels sendet der Studierende Abstract und Kurzfassung per Mail an das zuständige Sekretariat.

Gilt nur für AT/Janschek:

  • Der Studierende legt im Sekretariat  (Petra Möge, BAR E04) termingerecht zwei Exemplare der Studienarbeit und die CD zur Bestätigung der Vollständigkeit vor
    ACHTUNG: Terminabsprache erforderlich
  • Das Sekretariat übergibt die Studienarbeit an die Betreuer bzw. die Gutachter und vereinbart den Verteidigungstermin.
  • Der Studierende sendet Abstract und Kurzfassung per Mail an das Sekretariat und erhält den Laufzettel (pdf-file).
  • Der Laufzettel ist vor dem Verteidigungstermin vollständig unterschrieben per Mail an das Sekretariat zurückzusenden.

Diplomarbeiten

Die Exemplare sind fristgemäß im Prüfungsamt der Fakultät einzureichen. Der Abgabemodus ist rechtzeitig per Mail mit der zuständigen Bearbeiterin im Prüfungsamt ET zu vereinbaren !! Eine persönliche Abgabe ist nicht immer möglich. Deshalb besteht die Möglichkeit, beide Exemplare + CD termingerecht über den Fristenbriefkasten der TUD einzureichen !! Erfolgt die Abgabe erst am nächsten Tag wird eine "Fehlleistung" registriert.

Gilt nur für PLT/Urbas:

  • Zuerst legen die Diplomanden dem Betreuer/verantw. Hochschullehrer termingerecht ein Exemplar der Diplomarbeit zur Bestätigung der Vollständigkeit vor (Signum und Datum auf Deckblatt).
  • Danach bringen die Diplomanden das vom Hochschullehrer signierte Exemplar in das Prüfungsamt der Fakultät Elektrotechnik und Informationstechnik zur Registrierung und Bestätigung. ACHTUNG: Terminabsprache mit dem Prüfungsamt wird dringend empfohlen !
  • Im Anschluss werden das signierte Exemplar und das zweite Exemplar der Arbeit sowie Kurzfassung/Abstract im PLT-Sekretariat abgegeben.
  • Das Sekretariat übergibt die Exemplare an die Betreuer zur Weiterleitung an die Gutachter.
  • Nach Erhalt des Laufzettels senden die Diplomanden Abstract und Kurzfassung per Mail an das Sekretariat.

Gilt nur für AT/Janschek:

  • Die Diplomanden reichen zwei Exemplare der Arbeit + CD termingerecht (keinen Tag später!) zur Registrierung im Prüfungsamt der Fakultät Elektrotechnik und Informationstechnik ein. ACHTUNG: Terminabsprache erforderlich !
  • Erfolgt die Abgabe über den Fristenbriefkasten werden die Exemplare per Hauspost an das Sekretariat weitergegeben. Andernfalls geben die  Diplomanden nach der Registrierung im Prüfungsamt umgehend beide Exemplare persönlich im AT-Sekretariat ab. (Petra Möge, BAR E04), ACHTUNG: Terminabsprache erforderlich !
  • Das Sekretariat übergibt die Diplomarbeit an die Gutachter und vereinbart den Verteidigungstermin.
  • Die Diplomanden senden Abstract und Kurzfassung per Mail an das Sekretariat und erhalten den Laufzettel (pdf-file).
  • Der Laufzettel ist vor dem Verteidigungstermin vollständig unterschrieben per Mail an das Sekretariat zurückzusenden.

4 Kurzfassung und Abstract

Kurzfassung und Abstract geben auf einer Seite DIN A4 einen zusammenfassenden Überblick über die Arbeit. Die Formulierung ist so zu halten, dass auch für Nichtspezialisten die Inhalte und Anwendungsaspekte der Arbeit zugänglich sind (Problembeschreibung/-einordnung, neue Lösungsansätze, Systemeigenschaften durch die neuen Ansätze, Anwendungsfelder). Die verbalen Aussagen sind durch ein charakteristisches Bild zur Thematik zu ergänzen.

--> Kurzfassung und Abstract sind per E-Mail an das zuständige Sekretariat zu schicken.
--> Mustervorlagen für Kurzfassung und Abstract  (docx.File)

5 Poster (nur Diplomarbeit)

Zur Veröffentlichung der wichtigsten Arbeitsergebnisse der Diplomarbeit im Posterschaukasten des Instituts für Automatisierungstechnik ist ein Poster zu gestalten und zur Verteidigung der Diplomarbeit vorzulegen. Gestaltungsrichtlinien sind im Anhang 2 dieser Empfehlungen enthalten. Die Maßangaben sind unbedingt verbindlich.

6 Verteidigung

Diplomarbeiten und Studienarbeiten werden öffentlich verteidigt. In diesen Verteidigungen halten die Kandidaten einen Vortrag über Ziele, Inhalt und Ergebnisse der vorgelegten Arbeit. Der Vortrag sollte maximal 30 Minuten dauern. Projektionsmöglichkeiten für Folien sollten genutzt werden (Projektor/Beamer stehen zur Verfügung). Anschließend erfolgt eine Diskussion, zu der die Kandidaten ein Schlusswort halten können.
Im Übrigen gelten die Bestimmungen der entsprechenden Diplomprüfungsordnung (siehe Prüfungsamt ET).

Besonderheiten bei Diplomarbeiten

  • Die Diplomanden reichen vor der Verteidigung ein Poster zur Diplomarbeit sowie den vollständig unterschriebenen Laufzettel im Sekretariat ein.
  • Die Diplomakte wird erst nach Vorlage des vollständig unterschriebenen IfA-Laufzettels an das Prüfungsamt weitergeleitet.

Besonderheiten bei Studienarbeiten

  • Die Studienarbeiter reichen den vollständig unterschriebenen Laufzettel im Sekretariat ein.
  • Das Prüfungsergebnis wird erst nach Vorlage des ordnungsgemäß ausgefüllten IfA-Laufzettels an das Prüfungsamt weitergeleitet.

Anhang

Anhang 1: Vorlagen zur Anfertigung einer studentischen Arbeit

Anhang 2: Postergestaltung

  LaTex-Postervorlage    125 K
  PowerPoint-Postervorlage    126 K

Schwerpunkte

  • Kurzvorstellung der Aufgabe
  • Anschauliche Darstellung des Lösungsweges und wesentlicher Ergebnisse, möglichst durch Bilder und Tabellen unterstützt (kurze Texte, 14 pt / 3mm)
  • Zusammenfassende Wertung der Ergebnisse und Ausblick auf noch zu lösende Probleme.

Gestaltung

Größe:

  • DIN A2 - Querformat (59,4 x 42,0 cm), allseitiger Rand 2 cm

Kopf:

  • Überschrift (Kurzthema), Schriftgröße: 90 pt, fett (20 mm)
  • Logo-Block (Schriftgröße: 18 pt (4 mm) / 14 pt (3 mm):

Gestaltung des Logo-Blocks

Maße und Schriftgrößen siehe oben

Anhang 3: Informationsmittel zur Literaturrecherche

Wegen der ständig anwachsenden Zahl von Veröffentlichungen ist es angebracht, bei der Literaturrecherche rationelle Methoden anzuwenden. Dafür stehen Informationsmittel in den wissenschaftlichen Bibliotheken zur Verfügung.

Rechnergestützte Recherche-Mittel:

  • Rechnergestützter Katalog OPAC (Monographie-Bestand der SLUB)
  • Recherchen in CD-ROM-Datenbanken verschiedener Hersteller SLUB
  • IEEE-Dokumente: Aufsätze, Tagungsbandbeiträge etc. (Volltexte Uni-IP)
  • TOC Premier: Zeitschrifteninhaltsverzeichnisse führender Verlage weltweit (Literaturrecherche von Uni-IP)
  • Datenbank FIZ Technik und Unterdatenbanken: (Literaturrecherche von Uni-IP)
  • Online-Informationsdienst in kostenpflichtigen Datenbanken SLUB
  • Internet

Anhang 4: Hilfestellung zum wissenschaftlichen Schreiben

Anhang 5: Spezielle Anforderungen an Installationsanleitung und Portierungsanleitung für Software

Das Ziel der Installation beschränkt sich auf das Ausführen der Software. Das Ziel der Portierung erweitert sich auf die Weiterentwicklung der Software. Dies beinhaltet i.A. auch eine Kompilierung der Software ohne jegliche Änderungen im Quellcode. Durch die Installationsanleitung und die Portierungsanleitung sollen unproblematische Installation und Portierung der Software auf die erforderliche Rechnerplattform sichergestellt werden.

5.1 Installationsanleitung

Die Installationsanleitung ist eine klare, eindeutige und detaillierte Darstellung aller Handlungsschritte, die durchgeführt werden sollen, um die Software:

  • von einem (mitgelieferten) Datenträger (mit ausführbaren Datei(en), Konfigurationsdatei(en), Bibliothek(en) usw.),
  • auf einer Rechnerplattform mit einer zur Ausführung erforderlichen Konfiguration (ggf. mit einer speziellen Programmierhardware, z.B. für FPGA)

zu installieren, sodass die Software ausgeführt werden kann. Die zur Ausführung erforderliche Konfiguration der Rechnerplattform ist hier zu beschreiben.

5.2 Portierungsanleitung

Die Portierungsanleitung ist eine klare, eindeutige und detaillierte Darstellung aller Handlungsschritte, die durchgeführt werden sollen, um die Software:

  • von einem (mitgelieferten) Datenträger (mit Quelldatei(en), Konfigurationsdatei(en), Bibliothek(en) usw.),
  • auf eine Rechnerplattform mit einer zur Entwicklung erforderlichen Konfiguration (ggf. mit einer speziellen Programmierhardware, z.B. für FPGA)

zu übertragen und auf dieser Rechnerplattform kompilieren, ausführen und weiterentwickeln zu können. Die zur Entwicklung erforderliche Konfiguration der Rechnerplattform ist hier zu beschreiben.

5.3 Beschreibung der erforderlichen Konfiguration der Rechnerplattform

Die erforderliche Konfiguration der Rechnerplattform legt sowohl die Hardware als auch die Software (inkl. Betriebssystem(e) und ggf. Entwicklungssoftware) der Rechnerplattform fest, welche zur Ausführung bzw. zur Weiterentwicklung der Software erforderlich sind. Die jeweilige erforderliche Konfiguration ist in der Installationsanleitung und in der Portierungsanleitung zu beschreiben. Falls dies in einem anderen Dokument erfolgt, soll ein eindeutiger Hinweis mit einem Verweis auf dieses Dokument eingefügt werden. Die Softwarekomponenten der erforderlichen Konfiguration werden unter der Angabe von vollständigen Namen, Version(en) und bei Open Source Software von Bezugsquelle(n) spezifiziert. Die Installation dieser erforderlichen Software ist ebenfalls zu beschreiben. Verweise auf vorhandene Installationsanleitungen sind möglich, eventuelle ergänzende oder abweichende Schritte sind hier anzugeben.

Zu dieser Seite

Petra Möge
Letzte Änderung: 11.06.2024