Ich schreibe meine Dokumentationen gerne in LaTeX. Die Schriftform und die Handhabung gefällt mir bei diesen Dokumentationen einfach besser. Das Problem für mich bei LaTeX ist aber, dass erst mehrere Zeilen Code benötigt werden, damit ein einigermaßen annehmbares Layout zu besitzen.
Daher habe ich mir ein „minimales“ Standardlayout erstellt, um alle Parameter und Layoutpunkte gleich zu haben. Man kann aber auch ein TeX Dokument mit nur diesen Zeilen erstellen.
\documentclass{article}
\begin{document}
Hello World!
\end{document}
Hier sieht man, das TeX eigentlich kein Hexenwerk ist.
Für größere Dokumente sollte man jedoch globale Klassen, Definitionen usw. für Tabellen usw. laden, damit die Dokumentation ansprechender wirkt.
Das Layout:
Als Screenshot seht ihr die Eckpunkte des Dokuments für mein LaTeX Template
Screenshot meines Standardlayouts
Mein CodeSchnipsel:
Dieses Codeschnipsel zeigt die Grundfunktionalität der Dokumentation:
% === Anfang: Seitenlayout Kopf & Fußzeile =====
\documentclass[10pt,oneside,a4paper]{scrreprt}
\usepackage[left=20mm,right=20mm,top=10mm,bottom=10mm,includeheadfoot]{geometry} % Einstellungen der Seitenränder
\usepackage{natbib} % Benötigt wegen URL Verweise in Literatur DB
\renewcommand{\chapterpagestyle}{scrheadings} % Benötigt wegen Kopf/Fußzeile bei Kapitelänfangen
\usepackage{tabularx} % Benötigt wegen Tabelle tabularx
\usepackage{ngerman} % neue Rechtschreibung
\usepackage{pgfgantt} % GANTT Zeichungen
\usepackage[utf8]{inputenc} % Umlaute ermöglichen
\usepackage{listings} % Einbinden von Quellcode in LaTeX
\usepackage{color} % Farben in LaTeX
\usepackage{graphicx} % Damit Grafiken eingebunden werden können
\usepackage{float} % Erweiter Modus wegen Positonierung {table}[H]
\usepackage{mdwlist} % Kleinerer Zeilenabstand bei Aufzählungen (\item)
%Kopf- und Fußzeile
\usepackage{fancyhdr}
\pagestyle{fancy}
\fancyhf{}
\fancyhead[L]{\nouppercase{\leftmark}} % Kopfzeile links bzw. innen
\rhead{\includegraphics[height=0.5cm]{images/CompanyLogo.png}}
\renewcommand{\headrulewidth}{0.5pt} % Linie oben
\fancyfoot[L]{Carlos Melzer (\today) } % Fußzeile links bzw. innen
\fancyfoot[R]{\thepage} % Fußzeile rechts bzw. außen
\renewcommand{\footrulewidth}{0.5pt} % Linie unten
% === Ende: Seitenlayout Kopf & Fußzeile ========
% === Anfang: Haken ok, Bemerkung oder nicht ok =
\usepackage{amsfonts}
\usepackage{pifont}
\newcommand{\tickYes}{{\textcolor{darkgreen}\checkmark}}
\newcommand{\tickNo}{\textcolor{red}{\hspace{1pt}\ding{55}}}
\newcommand{\tickMessage}{\textcolor{red}{\hspace{1pt}\ding{45}}}
% === Ende: Haken ok, Bemerkung oder nicht ok ===
% === Anfang: PDF Informationen =================
% Hyperlinks und interne PDF-Verweise
\usepackage{hyperref}
\hypersetup{
pdftitle={Vorlage f\"ur Dokumentationen},
pdfsubject={LaTeX basierte Standardokumentation},
pdfauthor={Carlos Melzer},
pdfcreator={Carlos Melzer},
pdfkeywords={TeX} {LaTeX} {Windows} {Linux} {TeXStudio} {TeXNicCenter}
}
% === Ende: PDF Informationen ===================
% === Anfang: Abkürzungsverzeichnis =============
% Abkürzungsverzeichnis
\usepackage{nomencl}
\let\abbrev\nomenclature
\renewcommand{\nomname}{Abk\"urzungsverzeichnis}
\setlength{\nomlabelwidth}{.55\hsize}
\renewcommand{\nomlabel}[1]{#1 \dotfill}
\setlength{\nomitemsep}{-\parsep}
\makenomenclature
\newcommand{\Abkuerzung}{
\printnomenclature
\newpage
}
% === Ende: Abkürzungsverzeichnis ===============
% === Anfang: Dokument ==========================
\begin{document}
% === Anfang: Titelseite ========================
\begin{minipage}[b][\textheight][t]{0.3\textwidth}
\, \includegraphics[width=0.9\textwidth]{images/sap-logo.png} \\\\
\includegraphics[width=0.9\textwidth]{images/Solution-logo-1.png} \\\\\\
\includegraphics[width=0.9\textwidth]{images/Solution-logo-2.png} \\\\\\
\includegraphics[width=0.9\textwidth]{images/Solution-logo-3.png} \\\\\\
\includegraphics[width=0.9\textwidth]{images/Solution-logo-4.png} \\\\\\
\includegraphics[width=0.9\textwidth]{images/Solution-logo-5.png} \\\\\\
\vfill
\includegraphics[width=0.9\textwidth]{images/CompanyLogo.png}
\end{minipage}%
\begin{minipage}[b]{1ex}
{\color{gray} \rule{0.1ex}{\textheight}}
\end{minipage}\hfill%
\begin{minipage}[b][\textheight][c]{0.65\textwidth}
\flushright\vspace{10cm}
\Huge{\textbf{{\LaTeX Template}}}\\ \vspace{1cm}
\Large{\textbf{Vorlage f\"ur Dokumentationen}}\\ \vspace{1cm}
\Large{\textbf{Carlos Melzer}}\\ \vspace{1cm}
\vspace*{\fill}
\large{\textbf{\today}}
\date{}
\maketitle
\end{minipage}
% === Ende: Titelseite ==========================
\tableofcontents % Inhaltsverzeichnis
\newpage
\addcontentsline{toc}{section}{Abbildungsverzeichnis}
\listoffigures % Abbildungsverzeichnis anzeigen
\newpage
\addcontentsline{toc}{section}{Abk\"urzungen} % Abkürzungsliste anzeigen
\Abkuerzung
% Einbinden weiterer TeX Dateien
\newpage
\input{Tex_Doc_1}
\input{Tex_Doc_2}
\input{Tex_Doc_3}
\addcontentsline{toc}{section}{Literatur}
\bibliography{Literatur}{} % Einbinden der Literaturdatenbank
\bibliographystyle{unsrtnat}
\nocite{*} % Literatur ohne Zitate im Dokument angeben
\end{document}
% === Ende: Dokument ============================
Natürlich kann man den Code jederzeit erweitern. Optional können farbige Tabellen, GANTT Graphen usw. mittels LaTeX abgebildet werden.