Aus Linux-Magazin 02/2012

Drei Helfer für gute Pflichtenhefte

© John Dow, photocase.com

Niemand mag sie schreiben, doch sind sie geradezu ein Wundermittel gegen das Scheitern von Softwareprojekten, gegen überzogene Kundenwünsche und Verständnisprobleme zwischen Auftraggebern und Dienstleistern: Pflichtenhefte. Textverarbeitungen und Templates bieten eine solide Arbeitsgrundlage.

“Hallo lieber Dienstleister, in diesem komischen WordPress fehlt ein Knopf, mit dem ich den Text blinkend machen kann, und außerdem will ich das Logo links oben gegen eines mit Weihnachtsmütze austauschen, das mein Neffe selbst mit Paint gemalt hat. Wäre schön, wenn Sie das bis gestern erledigen können, ich hab vor zwei Jahren schließlich genug für das Blog gezahlt.” So oder doch so ähnlich könnte er klingen, der Anruf eines Kunden aus der Hölle [1], der aber vielleicht endlich den Anstoß dazu gibt, in Zukunft nur noch mit Lasten- und Pflichtenheften zu arbeiten, um die Kommunikation zu verbessern.

Beispiel: Ein Kunde namens “Pizza auf heißen Reifen” gibt ein neues Web-Bestellsystem beim mittelständischen Softwarehaus “Zuses Erben” in Auftrag. Im Lastenheft beschreibt der Pizzabäcker genau seine Wünsche und Forderungen und erklärt, was das neue System können soll und wie es an die internen Vorgänge der einzelnen Filialen angekoppelt ist. Das Pflichtenheft wiederum beschreibt, wie und womit “Zuses Erben” die Anforderungen erfüllen wollen.

Auf diese Weise erhalten sowohl Kunde als auch Dienstleister Gewissheit, dass die Programmierer genau im Blick haben, wie sie die technische Seite der Aufgabe anpacken wollen, aber das Verfahren zeigt auch die Grenzen der Zusammenarbeit auf. So bietet “Zuses Erben” dem Pizzakonzern beispielsweise eine grundlegende Schulung aller Filialleiter an, schiebt aber zugleich Wünschen nach andauerndem kostenlosen Support einen schriftlichen Riegel vor.

Vor der eigentlichen Entwicklung, der Praxis, steht also zunächst die mehr oder weniger trockene Pflicht, die Theorie. Wie genau ein solches Heft aufgebaut sein sollte und was hineingehört, ist längst nicht allgemeingültig geklärt. Als heimlicher Standard gilt das Konzept des Dozenten für Softwaretechnik Helmut Balzert [2]; ein Gliederungsvorschlag findet sich unter [3].

Technische Hilfsmittel ersetzen zwar keine grundlegenden Kenntnisse über Pflichtenhefte und deren Struktur, erleichtern aber die Arbeit. Als Assistenten treten in diesem “Bitparade”-Test ein Open-Office-Template und eine Latex-Vorlage an. Beide messen sich mit der hierarchischen Textverarbeitungsumgebung Scrivener. Auf dem Prüfstand stehen nicht nur die Benutzerfreundlichkeit, sondern die drei Kandidaten sollen auch zeigen, wie aufwändig es ist, sie an eigene Bedürfnisse anzupassen, und wie viel Vorwissen sie dem Pflichtenheft-Autor abverlangen.

Open-Office-Template

Wenn der Mitarbeiter von “Zuses Erben” mit der Arbeit am Pflichtenheft beginnt, greift er vielleicht zu einem Office-Tool und hält, um das Rad nicht neu zu erfinden, Ausschau nach passenden Vorlagen. Für MS Word gibt es diese zuhauf im Netz ([4], [5], [6]) – mit den üblichen Problemen beim Umwandeln in offene Formate. Das Angebot für Open Office und Libre Office ist dagegen eher überschaubar, zumindest bei den deutschen Templates.

Bei den englischsprachigen Vorlagen sieht es etwas besser aus. Hier bietet sich das übersichtliche Template “Software Requirements Specification” aus dem Open-Office-Vorlagenrepository [7] an, das in deutscher Übersetzung auch der Heft-DVD beiliegt. Das Dokument steht unter BSD-Lizenz und arbeitet problemlos mit Installationen ab Version 2.0 zusammen. Wie zu erwarten war, kann auch Libre Office damit umgehen.

Die Vorlage verzichtet auf umfangreiche Makros und ist daher auch für typische Office-Anwender kein Buch mit sieben Siegeln. Grundlegende Einstellungen nimmt der Pflichtenheft-Autor über die Dokumenteneigenschaften aus dem »Datei« -Menü vor (siehe Abbildung 1). Dazu gehören unter anderem der Copyright-Hinweis, die Lizenz und der Titel und der Inhalt der Kopfzeilen. Hilfreiche Kommentare, die die Bestandteile der Gliederung für den Pflichtenheft-Novizen erläutern, fehlen. Die klare und überschaubare Struktur des Templates entschädigt jedoch dafür.

Abbildung 1: Einige Elemente wie etwa den Titel, die Kommentare, den Copyright-Hinweis und auch den Inhalt der Kopfzeile passt der Nutzer in den Open/Libre-Office-Dokumenteneigenschaften an.

Abbildung 1: Einige Elemente wie etwa den Titel, die Kommentare, den Copyright-Hinweis und auch den Inhalt der Kopfzeile passt der Nutzer in den Open/Libre-Office-Dokumenteneigenschaften an.

Wer das englische Original selbst übersetzen und nicht die Version von der Heft-DVD verwenden möchte, der sollte dies in weniger als einer Arbeitsstunde erledigen können – vorausgesetzt die Fachtermini zu Pflichtenheften sind einigermaßen vertraut.

Bilder und Diagramme finden über die Tools der Officesuite ins Pflichtenheft. Dass die Arbeit mit komplexen grafischen Objekten eher zeitraubend ausfällt, liegt aber nicht am Template, sondern am Programm selbst, das eben keine Desktop-Publishing-Qualitäten hat. Der engagierte Anwender rettet sich jedoch mit etwas Schweiß und Flüchen über die Runden.

Die freie Officesuite speichert und exportiert in eine ganze Reihe von Formaten. Neben dem hauseigenen Open-Document-Format (».odf« ) unterstützt die Anwendung MS Word, Rich Text und selbstverständlich PDF. Damit ist das Pflichtenheft bereit für den Ausdruck oder den Versand per E-Mail.

Wie bei einem englischen Template zu erwarten, basiert es nicht auf dem Entwurf von Balzert. Dennoch ist die Vorlage hilfreich und Nutzer schneidern sie mit wenigen Handgriffen auf eigene Bedürfnisse zu. Das Office-Template ist somit ein solider Sockel für alle Pflichtenheft-Autoren, die ihre gewohnte Schreibumgebung benötigen, aber nicht bei null starten wollen.

Latex-Template

Wesentlich eleganter, aber auch deutlich anspruchsvoller fällt die Arbeit mit dem zweiten Testkandidaten aus, dem freien Latex-Template des Diplom-Informatikers Stefan Baur [8]. Die Vorlage hat er in der Miktex-Umgebung [9] unter Windows entwickelt, sie kooperiert aber auch mit einer Standard-Latex-2e-Umgebung unter Linux und Mac OS X. Die benötigten Pakete (»babel« , »cordsys« , »logsys« , »hyperref« und »texdraw« ) sind in gängigen Texlive-Installationen [10] bereits vorhanden.

Wer nicht gerne in einem Texteditor arbeitet, der kann alternativ die Entwicklungsumgebung Kile [11] heranziehen (Abbildung 2). Auch sie arbeitet problemlos mit Latex zusammen.

Abbildung 2: Fans von Texteditoren und auch Anhänger der Entwicklungsumgebung Kile können die Latex-Vorlagen für Pflichtenhefte unter Linux verwenden.

Abbildung 2: Fans von Texteditoren und auch Anhänger der Entwicklungsumgebung Kile können die Latex-Vorlagen für Pflichtenhefte unter Linux verwenden.

Die Vorlage ist gut strukturiert und in 14 einzelne Dateien aufgeteilt, was der Übersichtlichkeit eines längeren Dokuments spürbar gut tut. Beispieltext und Kommentare helfen bei der Orientierung in den ».tex« -Dateien. Dennoch ist Vorsicht geboten – es gilt, aufmerksam und konzentriert den Fremdtext (und vor allem den Namen des Autors) zu entfernen, damit keine unerwünschten Artefakte überleben.

Vor dem ersten »latex« -Durchlauf ist noch eine Zeile zum Hauptdokument (Datei »Pflichtenheft.tex« ) hinzuzufügen. Im Header der Datei fehlt die korrekte Direktive zum Paket »fancyhdr« :

\usepackage{fancyhdr}

Auch Latex-Novizen meistern die Arbeit mit diesem Template ohne weiterführende Lektüre eines Fachbuchs. Wer in die Tiefen des Pakets »texdraw« einsteigen oder die Vorlage um weitere Grafiken erweitern möchte, dem seien die beiden Anleitungen unter [12] und [13] ans Herz gelegt. Erstere erlaubt Diagramme direkt im Dokument zu definieren und bei Bedarf zu verändern, ohne auf externe Grafikprogramme zurückgreifen zu müssen.

Der Latex-Aufruf erstellt in der Regel eine DVI-Datei, die der Pflichtenheft-Autor per Kommando ins Postscript- oder PDF-Format umwandeln kann. In Kile finden sich fertige Schaltflächen für diese Aufgabe, und auch das auf der Heft-DVD beigelegte Shellskript kompiliert und erstellt ein PDF in einem Rutsch. DVI-Ausgabetreiber für verschiedene Grafikformate existieren ebenfalls.

Die Latex-Vorlage folgt ziemlich genau der von Balzert empfohlenen Struktur und macht das Template zur ersten Wahl, wenn diese gewünscht oder gefordert ist. Der Anwender sollte allerdings grundlegende Latex-Kenntnisse mitbringen oder dazu bereit sein, die anfänglich etwas steile Lernkurve für das Textsatzsystem zu meistern.

Scrivener

Die Schreibsoftware Scrivener ([14], [15]) scheint auf den ersten Blick nicht das geeignete Tool für Pflichtenhefte zu sein. So verwundert es auch nicht, dass keine fertigen Templates im Netz zu finden sind. Als hierarchisch organisierte Textverarbeitungsumgebung ist es jedoch in sehr kurzer Zeit möglich, eine eigene Vorlage zu erstellen. Scrivener teilt umfangreiche Dokumente auf Wunsch in kleine Unterdokumente auf und organisiert diese wiederum über Ordner. Außerdem muss sich der Autor nur am Rande mit der Textformatierung beschäftigen. Was bei der Eingabe nicht perfekt aussieht, passt er im letzten Arbeitsschritt beim Zusammensetzen der Texte an.

Für das Erstellen einer eigenen Vorlage verwendet der Autor am besten das Scrivener-Standardtemplate. Mit dem Binder definiert er eine Struktur für die einzelnen Ordner und Dokumente, die das gewählte System abbildet. Im Dialog »Compile« aktiviert der Schreiberling außerdem im Bereich »Formatting« eine Funktion, die Titel der Ordner und Textelemente als Überschriften ins fertige Dokument übernimmt (siehe Abbildung 3). Das Aussehen der Überschriften sowie den Inhalt der Kopf- und Fußzeilen legt er hier ebenfalls fest.

Abbildung 3: In der Schreibumgebung Scrivener legen Autoren das Layout ihrer Texte an zentraler Stelle fest, das heißt im Compile-Dialog. Beim Einbinden von Bildern bereitet das Tool jedoch Probleme.

Abbildung 3: In der Schreibumgebung Scrivener legen Autoren das Layout ihrer Texte an zentraler Stelle fest, das heißt im Compile-Dialog. Beim Einbinden von Bildern bereitet das Tool jedoch Probleme.

Steht das Grundgerüst, also die Struktur und die Formatierung des Pflichtenhefts. speichert der Nutzer zunächst die Compiler-Optionen unter einem passenden Namen ab und wählt danach aus dem Menü »File« den Eintrag »Save as Template« aus.

Ein brauchbares Scrivener-Template für Pflichtenhefte stellen Anwender so in maximal zwei bis drei Stunden auf die Beine. Die Vorlage, die beim Schreiben des Artikels entstand, befindet sich übrigens zusammen mit dem Libre/Open-Office- und dem Latex-Template auf der Heft-DVD.

Pixelblockade

Störrischer als ein korsischer Esel verhält sich jedoch Scrivener für Linux derzeit bei Grafiken. Die Schreibumgebung importiert zwar fertige Bilder, kann aber selbst keine erstellen – nicht einmal rudimentäre Torten- oder Balkendiagramme wie bei Open/Libre Office. Umfließenden Text kennt die Anwendung nicht; schließlich ist sie nicht als Desktop-Publishing-Tool konzipiert. Die Konfigurationsoptionen eingebetteter Bilder beschränken sich auf das Skalieren mit automatischer Seitenanpassung.

Scrivener bietet die gleichen Zielformate wie Officesuiten an, also PDF, das Open-Document-Format, MS Word und RTF. Dazu gesellen sich Postscript, Epub und Mobipocket. So schlagen Tablet- und Smartphone-Benutzer auch unterwegs schnell im Pflichtenheft nach.

Die Lernkurve für Scrivener ist nicht steiler oder flacher als bei gängigen Textverarbeitungen. Wer mit Open/Libre Office oder MS Word arbeitet, der findet sich hier schnell zurecht und schreibt ohne lange Einarbeitungszeit ein Pflichtenheft. Lediglich die eingeschränkten grafischen Qualitäten sind ein Hindernis für Anwender, die gerne in Bildern ausdrücken, was Tausend Worte nicht schaffen.

Erst kommt die Pflicht, dann die Kür

Wer ohnehin mit einer Bürosuite arbeitet, findet im Office-Template beziehungsweise in seiner deutschen Übersetzung einen zuverlässigen Helfer und gelangt in wenigen Schritten zu einem grundlegenden Pflichtenheft. Anwender, die gerne der Anleitung von Balzert folgen möchten, passen den ersten Testkandidaten an und erweitern ihn entsprechend.

Alternativ investieren sie die Zeit in die Erstellung eines Scrivener-Templates – die Schreibumgebung arbeitet gerade bei umfangreichen Texten zuverlässiger und schneller. Die Unterteilung in mehrere kleine Dokumente hilft Autoren zudem bei der Orientierung und macht den Arbeitsablauf flüssiger.

Qualitativ können beide Kandidaten jedoch nicht mit der Latex-Vorlage mithalten, die sich von vornherein wesentlich detaillierter und strukturierter präsentiert. Zwar ist die Einarbeitung für Latex-Neulinge nicht zu unterschätzen, das typografische Ergebnis ist aber eleganter. Die Möglichkeiten, die sich durch »texdraw« ergeben, entsprechen darüber hinaus exakt den Bedürfnissen der Softwarebranche. Somit ist ein hochwertiges Pflichtenheft garantiert.

DELUG-DVD :Vorlagen für Pflichtenhefte

Auf der DELUG-DVD dieses Magazins befinden sich die in diesem Artikel beschriebenen Templates für Open/Libre Office, für Latex und für Scrivener. Die Officesuite-Vorlage ist eine Übersetzung aus dem Englischen. Das Latex-Template enthält zusätzlich zu den ».tex« -Dateien auch ein eigenes Shellskript, das die Befehle der mitgelieferten ».bat« -Dateien für Windows ersetzt. Die Scrivener-Vorlage ist eine Eigenproduktion der Autorin.

LINUX-MAGAZIN KAUFEN
EINZELNE AUSGABE Print-Ausgaben Digitale Ausgaben
ABONNEMENTS Print-Abos Digitales Abo
TABLET & SMARTPHONE APPS Readly Logo
E-Mail Benachrichtigung
Benachrichtige mich zu:
0 Kommentare
Älteste
Neuste Beste Bewertung
Inline Feedbacks
Alle Kommentare anzeigen
Nach oben