Technische Dokumentation

Sprachen Deutsche Sprache
1

Hallo,

ich schreibe gerade meine Assistentenarbeit (so ne Art Vorstufe von Diplomarbeit) in MS Word.

Ich benutze dazu die in unsrer Firma übliche Doku-Vorlage. Die hat aber meiner Ansicht nach gravierende Mängel und möchte das so nicht abgegeben. Das Inhaltsverzeichnis sieht total besch**** aus (verschiedene Schriftgrößen, Einrückungen, etc.). Die nummerierung ist seltsam, Die Abstände zwischen Überschriften und Texten sind komisch gewählt.

Gibt es irgendwo im Web Richtlinien an die ich mich wenden kann? Es handelt sich um eine technische Dokumentation (geht um Softwareentwicklung)

Danke
Bruno

2

Die Vorlage wird schon in Ordnung sein, ist aber wohl für einen anderen Anwendungsfall gedacht. Schlage vor, die Arbeit als .txt abzuspeichern, wodurch alle Formatierungen verloren gehen. Zunächst mit Ppier und Bleistift entwerfen, wie die Dokumentation aussehen soll und dann Stück für Stück umsetzen. Man sollte dazu allerdings schon WORD halbwegs beherrschen.
mfg Paul-W.

3

Ich bin ned grad Word-Profi aber das wird schon hinhauen…

In der BA hatten wir eine Vorlesung technische Dokumentation und ich finde unsere Firmenvorlage hier verletzt Regeln gleich dutzendweise :wink: Gibt es nicht irgendwo im Netz Anleitungen wie eine wissenschaftliche Arbeit gestaltet sein soll? Die BA gibt keine Vorgaben aber an Universtität oder sowas gibts das zum Teil glaube ich, oder? Daran könnte ich mich orientieren.

Wie muss z.b. ein Literaturverzeichnis aussehen etc. Damals der Typ in der Vorlesung hat da Zeugs erzählt, das hätt ich dem nie abgenommen, total kleinlich jedes Detail, leider hab ich da auch nicht so genau aufgepasst :wink: