Design and development of a standards-based authoring framework for software requirements specifications

Abstract

Da sich die Softwareindustrie immer noch ständig weiter entwickelt, ist es für Firmen nötig, ihre Absichten in der Form von Anforderungsdokumentation niederzuschreiben und diese Anforderungen sowohl intern, als auch mit ihren Kunden zu kommunizieren. Beim Verfassen der Anforderungsdokumentation verwenden Autoren heutzutage hauptsächlich Textverarbeitungsprogramme, sowie zusätzliche Software zur Erstellung von Grafiken. Diese Kombination von Werkzeugen bietet nur sehr wenige der Eigenschaften, die für die Erstellung, Prüfung, oder Wartung von solcher Dokumentation nötig ist, wie etwa transparente Versionierung, automatisierte Publizierung und erweiterbare Schnittstellen zur Verbindung von externen Systemen.<br />Das in dieser Arbeit vorgestellte Authoring Framework bietet Verbesserungen auf all den angesprochenen Ebenen und, aufgrund des Standars-basierten Konzeptes, Integrationspunkte für bestehende Software. Diese Arbeit zeigt, wie die einzelnen Teile der Komponenten des Frameworks - das Dokumentenformat, das Autorensystem, sowie das Repository - zusammen wirken, um eine Umgebung für die effiziente Erstellung von Dokumenten zu schaffen.<br />Bereits bestehende Lösungen für das Dokumentenformat und das Autorensystem werden analysiert und gegenübergestellt. Für beide Komponenten beschreibt diese Arbeit Kriterien, die dafür verwendet werden können, Lösungen für den Einsatz zur Dokumentationserstellung zu bewerten. Die daraus resultierenden Ergebnisse werden bei der Architektur und beim Design des Authoring Frameworks eingesetzt.<br />

In the constantly evolving software industry it is of vital importance for a company to document their intentions in the form of requirements documentation, and to communicate these requirements internally and together with their customers. In order to put down the requirements, authors currently mostly use word processors and a small set of tools to generate graphics. This combination provides very few features that are important to effectively create, review, and maintain a software requirements specification, such as transparent versioning, automated document sharing, and extensible integration points with external systems.<br />The authoring framework presented in this thesis provides improvements at all these levels, and, due to the standards-based concept, integration points for existing tools. This thesis shows how the different parts of the framework's components - the documentation format, the authoring tool, and the repository - can play together to create an environment for efficient document authoring.<br />Existing solutions (i.e. implementations) for the documentation format and authoring tool are analyzed and compared with one another. For both components, this thesis collects a set of criteria that can be used to assess how useful the solution may be for authoring processes. The results are taken into consideration for the eventually presented architecture and implementation of the authoring framework.