Nach dem Schreiben landet die Funktionsspezifikation oft auf einem Regal oder einem Webordner und wird vergessen. Laut Joel liegt die Schuld in diesem Fall beim Verfasser.

Fünf Regeln zum Schreiben einer interessanten Funktions-spezifikation. (Teil 2/2)

Nach dem Schreiben landet die Funktionsspezifikation oft auf einem Regal oder einem Webordner und wird vergessen. Laut Joel liegt die Schuld in diesem Fall beim Verfasser.

Im ersten Teil des Artikels haben wir gesehen, warum das Schreiben einer Funktionsspezifikation wichtig ist. Jetzt sehen wir, wie man das machen sollte.

Fünf Regeln damit die Funktionsspezifikation gelesen wird.

http://xkcd.com/243/

1. Schreiben Sie amüsant.

Wie geht das? Joel empfiehlt, dann spezifisch zu sein, wenn das niemand erwartet. Also sprechen Sie von “Mickey Mouse” oder “Tante Susanne” anstatt vom üblichen “Anwender”, dann liest es sich schon besser. Und wenn Sie “humoristisch/ironisch” gelagert sein sollten - wie in meinem Fall - sollten Sie versuchen, den Leser zu involvieren.

2. Schreiben Sie so, als wollten Sie Menschenhirne programmieren.

Das, was wir schreiben, muss von den Leuten und nicht vom Computer verstanden werden. Also deshalb besser nicht so präzise sein, wie ein sterbenslangweiliges technisches Handbuch, wenn der Leser dabei an Klarheit gewinnt. Normalerweise zeigt man einen Überblick und geht dann ins Detail.

Damit Sie gute Arbeit leisten, muss jeder Satz vom Leser in dem von uns geschaffenen Kontext verstanden werden. Versuchen wir also, uns in den Leser zu versetzen.

3. So einfach schreiben wie nur irgend möglich.

Die formale Sprache ermüdet den Leser schnell Also besser Umgangssprache. Falls Sie Schwierigkeiten haben sollten, einen klaren Satz zu schreiben, dann teilen Sie diesen lieber in zwei oder drei kurze Sätze auf. Schreiben Sie nicht seitenlangen Text: Verlieren Sie nicht auch den Faden, wenn Sie nur Text vor sich sehen? Verwenden Sie Aufzählungen, Tabellen, Bilder, Grafiken und viel leeren Platz, damit man besser lesen kann. Wenn Sie sich näher mit dem Schriftstil befassen wollen, dann schauen Sie sich das Stilhandbuch von Wikipedia an.

4. Kontrollieren und immer wieder lesen.

Auf diese Weise können Sie kleine Fehler und Wiederholungen, die Grammatik und Syntax korrigieren. Das ist unangenehm und unnütz für den Leser. Achten Sie insbesondere auf Fehler, wenn Sie alles in einem Rutsch schreiben oder wenn Sie nur Teile des Dokuments korrigiert haben, ohne den Rest anzupassen.

5. Benutzen Sie keine Templates.

Erliegen Sie nicht der Versuchung, eine Standarvorlage zu verwenden, die für alle Ihe Funktionsspezifikationen gleich ist. Das ist keine gute Idee. Sie fragen sich warum? Damit Sie den Leser nicht mit unnützen Abschnitten langweilen, die die Dokumente aufblähen und das Interesse beim Leser töten, da sie unnütz sind.

http://xkcd.com/1219/

Wann man die Funktionsspezifikation schreiben soll.

Die Funktionsspezifikation lebt mit dem Projekt und wird erst dann nicht mehr aktualisiert, wenn der Code nicht mehr weiterentwickelt werden muss.

Wer die Funktionsspezifikation schreiben sollte und wer nicht

Der Verfasser der Funktionsspezifikation sollte ein Techniker sein, aber nicht unbedingt ein guter Programmierer. Er sollte gut mit den Kunden umgehen können, grafische Schnittstellen gestalten und vor allem klar schreiben können. Bitte beachten: Charisma hilft laut Joel :)

Nicht nur Entwickler.

Keinen Entwickler zum Verfasser der Funktionsspezifikationen machen. Denn oft fehlen diesen Leuten eine oder mehrere Voraussetzungen, um im flüssigen Deutsch zu schreiben, ein wenig Diplomatie, Marktkenntnis, gute Kapazitäten auf dem UI-Design und Empathie zu den Mitmenschen. Deshalb sollten Sie die Funktionsunterlagen auch nicht von einem Marketingleiter schreiben lassen, das kann Sie teuer zu stehen kommen!

Wir danken xkcd für die Bilder: Appropriate TermReports.

Teilen auf

Share |

Zu gleichen Themen

Kommentare

comments powered by Disqus