K15t Blog
Integration der Anwenderdokumentation in agile Software-Entwicklung bei SoftProject
Eugen Krämer

Eugen Krämer am 15. August 2017

Eugen Krämer

Eugen Krämer am 15. August 2017

Integration der Anwenderdokumentation in agile Software-Entwicklung bei SoftProject

Der Softwarehersteller SoftProject verwendet für die Herstellung seiner Produkte den Ansatz der agilen Softwareentwicklung, der außerdem dafür sorgt, dass parallel zur Entwicklung auch gleichzeitig die Anwenderdokumentation erstellt wird.

Unser Professional Services Team hat SoftProject dabei unterstützt diesen voll integrierten Software-Entwicklungsprozess mit Atlassians JIRA, Confluence und den Entwicklertools Bamboo Server und Bitbucket Server umzusetzen.

Team Mitglieder

Agile Softwareentwicklung mit integrierten Prozessen

SoftProject entwickelt eine Plattform und Software-Werkzeuge zur Digitalisierung und Automatisierung von Geschäftsprozessen. Ihre Philosophie ist, möglichst viele Routineaufgaben zu automatisieren, um den Kopf für die wichtigen Dinge freizuhaben.

Um den Marktänderungen standzuhalten und kontinuierlich neue Features in immer kürzeren Release-Zyklen auszuliefern, setzt das Unternehmen auf agile Softwareentwicklung. Das heißt, Produktmanagement und Support stehen in engem Kontakt zu Kunden und Partnern, um neue Produktanforderungen umzusetzen.

Allerdings fehlte ein Ort, in der Anforderungen diskutiert, priorisiert und nachverfolgt werden konnten. Deswegen entschieden sie sich eine zentrale Plattform einzuführen, um

  • effizient und vernetzt Vorgänge zu planen und verwalten,
  • Code zu entwickeln,
  • zu reviewen und zu versionieren,
  • auf Knopfdruck komplett funktionale Software-Artefakte zu erzeugen.

Anforderungen an eine integrierte Softwareentwicklung

Ziel war es außerdem, Anwenderdokumentation, Schulungsunterlagen und Projektdokumente agil zu erstellen, zu verwalten und automatisiert zu erzeugen. SoftProject entschied sich also für einen integrierten agilen Software-Entwicklungsprozess, in dem Dokumentationen parallel zur Entwicklung erstellt werden konnten.

Bessere Zusammenarbeit mit Atlassian-Produkten

Da SoftProject bei seinen Kunden für hochwertige, integrierte IT-Lösungen bekannt war, lag die Messlatte für interne Prozesse natürlich hoch. Für ein Softwareunternehmen stellt sich in solchen Fällen auch immer die Frage, ob Software eingekauft oder selbst entwickelt werden soll.

Die Antwort kam Schritt für Schritt: Das Entwicklungs-Team nutzte für die Verwaltung von Software-Bugs und das Aufgabenmanagement bereits JIRA und war damit rundum zufrieden. Deshalb folgte kurze Zeit später Confluence als Wissen-, Informations- und Dokumentationsplattform und dann die Entwicklungstools Bamboo und Bitbucket.

Lösung für eine integrierte Softwareentwicklung bei SoftProject

Da alle Atlassian Produkte miteinander verknüpft werden können, waren die Weichen für eine Kaufentscheidung gestellt. Allerdings hatten die Verantwortlichen noch einige Fragen, die geklärt werden mussten.

Agile Software-Entwicklung aus einem Guss 

Die Antworten erhielt SoftProject von unserem Professional Services Team. Als Atlassian Platinum Solution Partner und Hersteller von Add-Ons für den Atlassian Marketplace haben wir schon viele kniffelige Fragestellungen gemeistert.

Deshalb führten wir mit dem SoftProject-Team erst einmal einen Starter-Workshop rund um die Administration und Wartung von JIRA und Confluence durch. Hier trugen die Teilnehmer alle Anforderungen an eine integrierte agile Software-Entwicklung zusammen. Anhand dieser Liste entwickelten unsere Experten gemeinsam mit SoftProject ein tragfähiges Konzept für eine integrierte Software-Lösung. Schnell war das gesamte Team von den Möglichkeiten der Atlassian-Tools überzeugt und der Weg in Richtung agile Software-Entwicklung wurde geebnet.

Lösung für eine integrierte Software-Entwicklung

Der positive Nebeneffekt: Das SoftProject-Team hatte auf einmal zwei begeisterte Atlassian-Beführworter, die sich seitdem dafür einsetzten, die vielen Integrationsmöglichkeiten zu nutzen, die Atlassian bietet.

Anwenderdokumentation erfolgreich integriert

Zum Erstellen und Verwalten der Anwenderdokumentation setzte die Technische Redaktion bei SoftProject bereits auf Atlassian Confluence. Mithilfe dieser Plattform konnten alle Beteiligten aus der Software-Entwicklung, dem Produktmanagement und der Qualitätssicherung gemeinsam und effizient an einer zentralen Stelle an Inhalten arbeiten.

Trotzdem blieben zu der Zeit noch einige Anforderungen an die Dokumentationsverwaltung mit Confluence offen: SoftProject wollte mehrsprachige Inhalte erstellen, Versionen verwalten und ihren Mitarbeitern das Veröffentlichen in relevanten Formaten ermöglichen. Wieder war unser Professional-Services-Team gefragt. Mithilfe von ausgewählten Scroll Add-Ons setzten sie den vollständigen Prozess zur Erstellung von Anwenderdokumentationen um.

Anwenderdokumentation integrieren mit Scroll Addons

So weit, so gut. Doch SoftProject war ein anspruchsvoller Kunde und die Tool-Integration ging ihnen immer noch nicht weit genug. Die in Confluence erstellten Inhalte für die Online-Hilfe, sollten nun auch automatisiert im EclipseHelp-Format und als PDF-Handbuch in die Software-Pakete eingefügt werden. Das war auch für unsere Experten eine Herausforderung. Gemeinsam fanden sie jedoch eine Lösung, bestehend aus folgenden Komponenten:

  • Atlassian Confluence Server
  • Scroll EclipseHelp Exporter sowie Scroll PDF Exporter und deren ReSTful API
  • Atlassian Bitbucket Server
  • Atlassian Bamboo Server

Mit den jeweils aktuellen versionsspezifischen Inhalten aus Confluence werden im Build-Prozess von Bamboo die PDF-Handbücher und die Online-Hilfe automatisch erzeugt. Sollten die automatisierten Tests nach der Generierung der Online-Hilfe fehlschlagen, benachrichtigt Bamboo automatisiert alle Beteiligten über eine HipChat-Nachricht.


Produkt Aufgaben im Entwicklungsprozess

Ergebnisse einer starken Zusammenarbeit

Gemeinsam mit den Verantwortlichen von SoftProject setzte unser Professional Services Team einen voll integrierten agilen Software-Entwicklungsprozess um. Seitdem können Entwickler Release-Pakete mit dynamisch erzeugter  Online-Hilfe automatisiert erzeugen. Confluence bildet dabei die Basis, in der alle Inhalte erstellt, überarbeitet und bei Bedarf direkt im grafischen Editor übersetzt werden. 

Das Konzept überzeugte SoftProject sogar so sehr, dass Confluence unternehmensweit die zentrale Quelle für alle Informationen wurde – angefangen von Konzepten, Besprechungsnotizen und Marketinginhalten, bis hin zum Intranet mit Kantinenplan und Telefonlisten.

Für weitere Anwendungsfälle bietet der Atlassian Marketplace meist ein passendes Add-on und wir stehen im Zweifelsfall beratend zur Seite. SoftProject erhält über uns außerdem immer den besten Umrechnungskurs für alle Produkte aus dem Marketplace – worüber sich auch die Buchhaltung freut.

Der Blick nach vorne

Für SoftProject ist die Weiterentwicklung ihrer IT-Architektur auf Basis von Atlassian-Produkten aber längst noch nicht abgeschlossen. Geplant ist eine mehrsprachige Anwenderdokumentation, die über das Add-on Scroll Viewport direkt aus Confluence als individuell gestaltetes Web-basiertes Help Center dargestellt wird.

Zuvor gilt es jedoch noch zu klären, ob der bisherige On-Premise-Betrieb von JIRA, Confluence und Co. durch ein Hosting-Angebot ersetzt und die Wartung und Administration der Server-Instanzen in die Hände von Experten abgegeben werden soll. Dann könnte sich neben dem Entwicklungsteam auch das Operationsteam von SoftProject voll und ganz auf seine Kernkompetenzen und Kunden konzentrieren.

Über SoftProject

Die SoftProject GmbH ist ein unabhängiges Software-Unternehmen mit Hauptsitz in Ettlingen bei Karlsruhe. Als Spezialisten für die Digitalisierung und Automatisierung von Geschäftsprozessen  bietet SoftProject aus einer Hand Produkte und Dienstleistungen rund um ihr Kernprodukt, die X4 BPM Suite. Zum umfassenden Leistungsspektrum zählen Consulting, Training, Support sowie Hosting für Lösungen auf Basis der X4-Technologie. Das im Jahr 2000 gegründete Unternehmen wächst überdurchschnittlich und beschäftigt heute mehr als 60 Mitarbeiter. Über 300 Unternehmen weltweit setzen auf die X4-Technologie von SoftProject. Mehr Informationen unter www.softproject.de


Industry IT Service and Consulting
Location Karlsruhe, Germany
Products Professional Services
Key Facts
  • Durchgängig integrierte Software-Prozesse
  • Erstellung der Anwenderdokumentation integriert in den Software-Entwicklungs-Prozess
K15t Software uses cookies to ensure you get the best experience on our website. More information
OK