Paket zur Erstellung wissenschaftlicher Arbeiten in LaTeX
Paket zur Erstellung wissenschaftlicher Arbeiten in LaTeX
Paket zur Erstellung wissenschaftlicher Arbeiten in LaTeX
Erfolgreiche ePaper selbst erstellen
Machen Sie aus Ihren PDF Publikationen ein blätterbares Flipbook mit unserer einzigartigen Google optimierten e-Paper Software.
Implementierungangesprochene Patch nicht aktiv ist und somit alle mit e<strong>in</strong>em Umlaut beg<strong>in</strong>nendenWörter im Abschnitt „Symbole“ des generierten Indexes e<strong>in</strong>sortiert werden.Dies wäre dann weniger schön.3.3 BenutzerdokumentationE<strong>in</strong> weiterer wichtiger Bestandteil der Implementierung des <strong>Paket</strong>s fomsdt wardie Bereitstellung e<strong>in</strong>er entsprechenden Benutzerdokumentation, auf die <strong>in</strong> diesemAbschnitt näher e<strong>in</strong>gegangen werden soll.Im Fokus des zu erstellenden Benutzerhandbuchs stand, dass es lediglich denAnspruch erheben sollte, dem Endanwender den Umgang mit dem <strong>Paket</strong> fomsdtzu erläutern. Daher erfolgte die Aufteilung beziehungsweise der Aufbau der e<strong>in</strong>zelnenHandbuchkapitel auf Basis des pragmatischen Ansatzes: Was <strong>in</strong>teressierte<strong>in</strong>en Benutzer zu welchem Zeitpunkt.Somit wurde während des Verfassens der <strong>Paket</strong>beschreibung besonderes Augenmerkauf das Vorhandense<strong>in</strong> von Anleitungen und Beispielen <strong>zur</strong> Verwendungder e<strong>in</strong>zelnen Komponenten des <strong>Paket</strong>s gelegt, da diese die Autoren <strong>wissenschaftlicher</strong><strong>Arbeiten</strong> am ehesten <strong>in</strong>teressieren würden.Im Gegenzug wurde auf e<strong>in</strong>e L A TEX-konforme Dokumentation aller Quellcodesverzichtet. Dies bedeutet aber nicht, dass auf die Quelltextkommentierung gänzlichverzichtet wurde. Denn für diejenigen Endbenutzer, die selbst Änderungenoder Anpassungen am <strong>Paket</strong> fomsdt vornehmen möchten, bef<strong>in</strong>det sich e<strong>in</strong>e vollständigeKommentierung des Quelltextes <strong>in</strong> der <strong>zur</strong> Auslieferung verwendeten<strong>Paket</strong>basis.Neben e<strong>in</strong>er Beschreibung der Funktionsweisen der e<strong>in</strong>zelnen bereitgestelltenKommandos ist e<strong>in</strong>e ausführliche Anleitung <strong>zur</strong> Installation des <strong>Paket</strong>s fomsdtebenfalls Bestandteil der Benutzerdokumentation.Die Entscheidung, alle Anweisungen <strong>zur</strong> Installation <strong>in</strong> der Dokumentation zu<strong>in</strong>tegrieren, wurde unter anderem auf Grund der e<strong>in</strong>geschränkten Möglichkeiten<strong>zur</strong> Hervorhebung und Formatierung von Texten <strong>in</strong>nerhalb von ASCII-Dateiengetroffen.Hieraus resultiert der durchaus als positiv zu bewertende Nebeneffekt, dass die<strong>Paket</strong>dokumentation durch den Endbenutzer erst erzeugt werden muss, bevormit der eigentlichen Installation begonnen werden kann. Dies gewährleistet,zum<strong>in</strong>dest gilt das für den Durchschnittsbenutzer, dass die Endbenutzerdokumentationauch auf dem Zielsystem vorhanden ist. Folglich kann der ebenfalls<strong>zur</strong> Dokumentation zu zählende Inhalt der Datei readme.txt bis auf e<strong>in</strong>e Kurzanleitung<strong>zur</strong> <strong>Erstellung</strong> des Benutzerhandbuches reduziert werden.84