CARDS+

Tag: Benutzerhandbuch

Was beschreibt der Baustein Manual?

Das Benutzerhandbuch ist das “Buch”, in dem die Bedienung der Software für die Nutzer beschrieben ist. Es ist Teil der Produktdokumentation. Projekte planen die Aktualisierung des Benutzerhandbuches gerne so spät wie möglich. In Projekten mit klassischen Vorgehensmodell  (“Wasserfall”) ist sowas noch einigermaßen gut planbar. Mit den agilen Methoden in den Projekten ergibt sich das Problem, dass am Ende des Sprints auch das Benutzerhandbuch fertig sein muss. Das ist meiner Ansicht nach nur schwer leistbar, weil der Großteil der Arbeit in der Gestaltung des Inhaltes liegt – fehlerfreie Inhalte vorausgesetzt. Oft ist die Gestaltung des Benutzerhandbuches und die Art der Veröffentlichung an Vorgaben des Unternehmens gebunden. Es ist auch schwer vorstellbar, dass jedes cross-funktionale Team die Rolle des technischen Redakteurs besetzen kann, wie es für ein professionelles Handbuch notwendig ist.

Im Zusammenhang mit der Spezifikation von Benutzeroberflächen der Anwendung unterscheiden wir Layouts und Manuals. Beide Artefakte haben das Ziel, die Benutzeroberfläche zu beschreiben.

In einem Manual beschreiben wir die Verwendung der Benutzeroberfläche, also das gewünschte fachliche Verhalten aus Sicht der Nutzer. Manuals sind als ideal geeignet, um daraus Testfälle abzuleiten. Aus diesem Grund werden während der Realisierung einer Benutzeroberfläche – hier verwenden wir die Layouts – für den Test bereits die Manuals erstellt. Wir legen für jeden Anwendungsfall, der durch die Akzeptanzkriterien einer User-Story gefordert wird, ein Manual an und beschreiben dort aus Sicht des Nutzers die besonderen Randbedingungen für die Verwendung der Benutzeroberfläche.

Continue reading

Was beschreibt der Baustein Layout?

Benutzeroberflächen sind das für die Nutzer sichtbare Ergebnis unseres Projektes. Zum einen unterstützt die Benutzeroberfläche Abläufe innerhalb von Geschäftsprozessen des Unternehmens. Auf der anderen Seite stellen die Daten, die mithilfe der Benutzeroberfläche erfasst werden, einen hohen Wert für die Nutzer und das Unternehmen dar. In der Benutzeroberfläche einer Anwendung steckt daher ein enormes Wissen. Dieses Wissen gilt es zu sichern.

In einem Layout beschreiben wir die Gestaltung und die Struktur der Benutzeroberfläche. Layouts benötigen wir bereits vor dem Start des Sprint in der geforderten Qualität. Mit bestimmten Typen von Layouts wird bereits in der Analyse der Versuch unternommen, wiederverwendbare Elemente der Benutzeroberfläche zu identifizieren. Teilbereiche der Benutzeroberfläche erfassen wir als Layouts vom Typ Panel. Der Designer der Benutzeroberfläche gibt dem Entwickler damit frühzeitig den Hinweis, dass es Potential für eine wiederverwendbare Software-Komponente gibt. Weitere Bausteine für eine geplante Wiederverwendung sind Layouts vom Typ Prompt und Widget.

Continue reading

Im Zusammenhang mit der Spezifikation von Benutzeroberflächen der Anwendung unterscheiden wir Layouts und Manuals. Beide Artefakte haben das Ziel, die Benutzeroberfläche zu beschreiben.

Was sind die Kosten?

Kosten sind in jedem Projekt ein Treiber für Veränderungen. Änderungen an der Software müssen ihre Kosten einsparen, sei es im Betrieb (durch Änderungen in der Architektur), in der Nutzung (Nutzer sind effektiver, wie auch immer das beurteilt wird) oder durch Reduktion von Lizenzgebühren, um nur ein paar Beispiele zu nennen.

09 Was sind die Kosten

Gerade im Zusammenhang mit der Produktdokumentation ist es besonders schwer, die Kosten für das Erstellen und Pflegen “kaufmännnisch” zu rechtfertigen. Es ist quasi unmöglich, eine Ziffer hinter den Wert gut gepflegter Dokumentation zu setzen. Darum ist es umso wichtiger, dass der Aufwand für die Erstellung und Pflege der Produktdokumentation minimiert wird.

Und genau das ist der Ansatz von CARDS+.

Continue reading

Welchen Nutzen bringt es?

Wer schon einmal als Analyst, Entwickler oder Tester in ein Projekt eingestiegen ist, das längere Zeit auf Sparflamme gewartet wurde, weiß den Wert guter Dokumentation schätzen – aber nur, wenn die Qualität gut und der Inhalt glaubwürdig ist. In allen anderen Fällen ist Dokumentation mehr Fluch als Segen.

08 Welchen Nutzen bringt es

Was sind nun die Herausforderungen, was die Probleme beim Erstellen und Pflegen einer Produktdokumentation? Welchen Nutzen bringt es uns, neben den obligatorischen Handbüchern auch eine Systembeschreibung zu erstellen und zu pflegen? Wie hilft uns eine Architekturdefinition?

Continue reading

Was bedeutet nachhaltig dokumentieren?

Eine bekanntes Mantra scrum-basierter Vorgehensmodelle der Software-Entwicklung ist, dass nur soviel dokumentiert wird wie notwendig ist für das Erreichen der Ziele. “So viel wie notwendig” ist natürlich ein dehnbarer Begriff. Eine vergleichbare Empfehlung hat das agile Manifest, indem es funktionierende Software höher bewertet als umfangreiche Dokumentation. In manchen Projekten wird diese Empfehlung als Rechtfertigung verwendet, fast nichts mehr zu dokumentieren. Und das Wenige, das doch aufgeschrieben wird, kann sehr oft nur von den Personen genutzt werden, die diese Dokumentation erstellt haben.

Auf der anderen Seite gibt es Projekte, die Unmengen von Wissen sammeln und ablegen. Oft fehlt ein klares Konzept, um mit der Informationsflut umzugehen. Über die Zeit entsteht so eine völlig inhomogene Sammlung unterschiedlichster Arbeitsdokumente. Kaum jemand ist in der Lage, eine Einschätzung zur Qualität dieser Dokumente abzugeben.

07 Was bedeutet nachhaltig dokumentieren

Continue reading

Wir sind agil!

Das Manifest für agile Softwareentwicklung legt in Punkt 2 ganz klar den Fokus auf funktionierende Software. In manchen Projekten wird dieser Wert ganz gern als Argument verwendet, dass in agilen Projekten nichts mehr dokumentiert werden muss. Das ist so nicht haltbar, weil das Manifest jeden Wert als Ganzes schätzt, nur halt die linke Seite höher als die rechte.

02 Wir sind agil

Continue reading

Was ist eine Produktdokumentation?

In einem Software-Projekt passiert eine ganze Menge. Projektmitarbeiter produzieren das Software-Produkt, also Code in einer oder mehreren Programmiersprachen und Konfigurationen für den Betrieb. Abhängig von der Projektorganisation und dem gewählten Vorgehen – phasen-orientiert, iterativ oder agil – schreiben Manager, Analysten und Spezialisten verschiedener technischer Disziplinen im Laufe der Zeit eine ganze Reihe von Dokumenten.

01 Was ist eine Produktdokumentation

Continue reading

Copyright © 2018 Impressum Datenschutz

Zum Anfang ↑