Neulich kam eine ungewöhnliche Anfrage rein – ein Styleguide und Dokumentationsberatung für eine in LaTeX geschriebene Systemdokumentation.

Mit LaTeX habe ich nur einmal zuvor gearbeitet, und dann damals mit Lyx, das dafür sorgt, dass man gar nicht erst der echten Syntax begegnet ;) Allerdings habe ich inzwischen zwei Jahre Docbook-Erfahrung, daher kann ich nach dem Lesen einiger Einführungen in LaTeX-Syntax zumindest grundlegend damit arbeiten.

Styleguides erstelle ich eigentlich regelmäßig, aber – das große Aber – normalerweise im Zuge der Dokumentationserstellung, also während ich selbst am Schreiben bin. Das ist mir erst jetzt bewusst geworden, dass ich ein Gefühl für die Materie brauche, bevor ich formale Dokumente zu deren Dokumentationserstellung schreiben kann.

Von dem her habe ich zu Übungszwecken den Styleguide selbst dann auch in LaTeX geschrieben. Und dabei gelernt, dass Tabellen in LaTeX-Syntax noch viel komplexer sind als in Wiki-Markup oder reStructured Text. Es ist halt nie handlich, eigentlich spaltenbasierte informationen in einen Zeilenfluß zu quetschen. Excel ist da definitiv einfacher, aber vom Vorschlag eines Kollegen neulich, man könne die Tabellen ja in Excel schreiben und dann einen Screenshot davon in die Dokumentation einbauen, kann ich nur dringend abraten. Zu schnell geht die Datei mit dem Original der Tabelle verloren, so daß zukünftige Generationen an Bearbeitern dann mühsam die Tabelle neu abtippen müssen.

Meine Installation auf Windows 7 besteht übrigens primär aus TeXMaker und MikTeX. Bei letzterem sollte man einstellen, dass fehlende Pakete auf Nachfrage nachgeladen werden. 

Share

Sorry, the comment form is closed at this time.

   
© 2012 Doku-Hotline Suffusion theme by Sayontan Sinha