24
CARDS+ Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg, deren Lösungen bundesweit zum Einsatz kommen. Unsere Lösungen sind von Beginn an qualitativ ausgereift, agil entwickelt, zukunftsfähig und mitwachsend bei unserer Leidenschaft für neue Technologien können wir gar nicht anders. © eMundo GmbH 2017 - www.e-mundo.de AGIL DOKUMENTIEREN MIT CARDS+

AGIL DOKUMENTIEREN MIT CARDS+ · 2017. 9. 9. · CARDS+ Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg,

  • Upload
    others

  • View
    1

  • Download
    0

Embed Size (px)

Citation preview

Page 1: AGIL DOKUMENTIEREN MIT CARDS+ · 2017. 9. 9. · CARDS+ Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg,

CARDS+

Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg, deren Lösungen bundesweit zum Einsatz kommen. Unsere Lösungen sind von Beginn an qualitativ ausgereift, agil entwickelt, zukunftsfähig und mitwachsend – bei unserer Leidenschaft für neue Technologien können wir gar nicht anders.

© eMundo GmbH 2017 - www.e-mundo.de

AGIL DOKUMENTIEREN MIT CARDS+

Page 2: AGIL DOKUMENTIEREN MIT CARDS+ · 2017. 9. 9. · CARDS+ Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg,

CARDS+

Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg, deren Lösungen bundesweit zum Einsatz kommen. Unsere Lösungen sind von Beginn an qualitativ ausgereift, agil entwickelt, zukunftsfähig und mitwachsend – bei unserer Leidenschaft für neue Technologien können wir gar nicht anders.

© eMundo GmbH 2017 - www.e-mundo.de

Systembeschreibung

Topic Produktdokumentation

Überblick

Die Produktdokumentation erfüllt alle geforderten Qualitätsmerkmale.

Die Produktdokumentation wird mit jedem Produktinkrement im Wiki bereitgestellt.

Die Produktdokumentation ist in der Sprache des Auftraggebers.

Die Pflege der Produktdokumentation folgt den Vorgaben und Empfehlungen der Methode CARDS+.

Epic Systembeschreibung

Motivation

Die Systembeschreibung umfasst das gesamte fachliche Produktwissen. Die Inhalte sind Ergebnisse aus Abstimmungen, Analysen und Entscheidungen der Stakeholder mit dem Product-Owner und Analysen der Projektmitarbeiter.

Abgrenzung

Die Systembeschreibung beinhaltet nicht

• das Benutzerhandbuch für Anwendungen,

• das Betriebshandbuch und

• Schnittstellenvereinbarungen.

Die Systembeschreibung enthält auch keine Dokumentation zur Projektorganisation oder zu den Prozessen, in denen sich Projektmitarbeiter bewegen.

Case Aufgabenbereich dokumentieren

AUSGANGSLAGE

Der Product-Owner möchte einen mit dem Auftraggeber abgestimmten Aufgabenbereich für das System angemessen dokumentieren.

LÖSUNG

Baustein Topic der Methode CARDS+.

Case Anforderung dokumentieren

AUSGANGSLAGE

Der Product-Owner möchte eine mit den Stakeholder erarbeitete Anforderung an das System angemessen dokumentieren.

LÖSUNG

Baustein Epic der Methode CARDS+.

Page 3: AGIL DOKUMENTIEREN MIT CARDS+ · 2017. 9. 9. · CARDS+ Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg,

CARDS+

Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg, deren Lösungen bundesweit zum Einsatz kommen. Unsere Lösungen sind von Beginn an qualitativ ausgereift, agil entwickelt, zukunftsfähig und mitwachsend – bei unserer Leidenschaft für neue Technologien können wir gar nicht anders.

© eMundo GmbH 2017 - www.e-mundo.de

Case User-Story vorbereiten

AUSGANGSLAGE

Der Product-Owner möchte die fachliche Beschreibung einer Funktion des Systems für die Verwendung in einer User-Story des Product-Backlog vorbereiten.

LÖSUNG

Baustein Case der Methode CARDS+ bildet die Grundlage der fachlchen Beschreibung in der Story. Akzeptanzkriterien und Subtasks werden im Zusammenhang mit Backlog-Management und Sprint-Planung in der Story ergänzt. Die Story beschreibt die Veränderung.

Epic Architekturentwurf

Motivation

Der Architekturentwurf umfasst alle Entscheidungen, die im Verlauf der Projektdurchführung vom Product-Owner oder dem Scrum-Team getroffen werden und sich auf das Produkt auswirken.

Der Architekturentwurf enthält auch alle technischen Konzepte, die sich aus den technischen Entscheidungen ergeben.

Abgrenzung

Der Architekturentwurf beinhaltet keine Beschreibungen von Komponenten des Systems.

Case Architekturentscheidung dokumentieren

AUSGANGSLAGE

Der Product-Owner möchte eine technische Entscheidung, die die Architektur des Systems betrifft, mit mindestens zwei Lösungsoptionen und Begründung der Entscheidung für eine Lösung dokumentieren.

LÖSUNG

Baustein Decision der Methode CARDS+.

Case Nicht-funktionalen Aspekt dokumentieren

AUSGANGSLAGE

Der Product-Owner möchte nicht-funktionale Aspekte als Randbedingungen für die Umsetzung des Systems mit mindestens zwei Lösungsoptionen und Begründung der Entscheidung für eine Lösung dokumentieren.

LÖSUNG

Baustein Decision der Methode CARDS+.

Epic Systemstruktur

Motivation

Die Systemstruktur umfasst alle Beschreibungen für Komponenten des Systems und ihre Abhängigkeiten.

Abgrenzung

Die Systemstruktur enthält keine technischen Entscheidungen und Konzepte.

Page 4: AGIL DOKUMENTIEREN MIT CARDS+ · 2017. 9. 9. · CARDS+ Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg,

CARDS+

Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg, deren Lösungen bundesweit zum Einsatz kommen. Unsere Lösungen sind von Beginn an qualitativ ausgereift, agil entwickelt, zukunftsfähig und mitwachsend – bei unserer Leidenschaft für neue Technologien können wir gar nicht anders.

© eMundo GmbH 2017 - www.e-mundo.de

Case Fachklasse dokumentieren

AUSGANGSLAGE

Der Product-Owner möchte für ein wichtiges Informationsobjekt eine angemessene technische Beschreibung.

LÖSUNG

Baustein Entity der Methode CARDS+.

Case Nachricht dokumentieren

AUSGANGSLAGE

Der Product-Owner möchte für eine Nachricht eine angemessene technische Beschreibung.

LÖSUNG

Baustein Event der Methode CARDS+.

Case Dienst dokumentieren

AUSGANGSLAGE

Der Product-Owner möchte für einen Dienst einer Komponente eine angemessene technische Beschreibung.

LÖSUNG

Baustein Service der Methode CARDS+.

Case Komponente dokumentieren

AUSGANGSLAGE

Der Product-Owner möchte für eine Komponente des Systems eine angemessene technische Beschreibung.

LÖSUNG

Baustein Domain der Methode CARDS+.

Topic Benutzerhandbuch

Überblick

Das Benutzerhandbuch wird mit jedem Produktinkrement als PDF-Datei bereitgestellt.

Das Benutzerhandbuch ist mehrsprachig.

Topic Betriebshandbuch

Überblick

Das Betriebshandbuch wird mit jedem Produktinkrement als PDF-Datei bereitgestellt.

Das Betriebshandbuch ist in der Sprache der Betriebsorganisation.

Page 5: AGIL DOKUMENTIEREN MIT CARDS+ · 2017. 9. 9. · CARDS+ Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg,

CARDS+

Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg, deren Lösungen bundesweit zum Einsatz kommen. Unsere Lösungen sind von Beginn an qualitativ ausgereift, agil entwickelt, zukunftsfähig und mitwachsend – bei unserer Leidenschaft für neue Technologien können wir gar nicht anders.

© eMundo GmbH 2017 - www.e-mundo.de

Topic Wiki

Überblick

Das Wiki wird in themenspezifische Bereiche aufgeteilt, z.B. Glossar und Produktdokumentation. Jeder Bereich des Wiki ist in Seiten und Unterseiten gegliedert. Seiten bilden eine baumartige Seitenhierarchie. Für das Anlegen von neuen Seiten gibt es Seitenvorlagen. Jede Bearbeitung einer Seite wird als Version der Seite gespeichert. Bilder werden in einer Medienbibliothek verwaltet.

Epic Bereich im Wiki

Motivation

Ein Bereich ist eine Sammlung von Seiten, Seitenvorlagen und Beiträgen. Bereiche isolieren die Inhalte voneinander. Besonders die Auflistung der zuletzt geänderten Seiten kann dadurch sehr effektiv genutzt werden. Auch die Sichtbarkeit von Nachrichten ist auf einen Bereich beschränkt.

Abgrenzung

Keine Angabe.

Case Bereich im Wiki erstellen

AUSGANGSLAGE

Als Gärtner im Wiki möchte ich einen leeren Bereich mit einem Titel und einem Logo erstellen.

LÖSUNG MIT CONFLUENCE

Weiterlesen auf https://confluence.atlassian.com/doc/create-a-space-139463.html

Case Bereich im Wiki einer Kategorie zuordnen

AUSGANGSLAGE

Als Gärtner im Wiki möchte ich für einen Bereich einer Kategorie zuordnen, die die Nutzung des Bereiches angibt:

• Die Kategorie “documentation” wird für Bereiche verwendet, in der die Produktdokumentation erstellt und gepflegt wird.

• In Bereichen der Kategorie “knowledge base” befinden sich die Regeln, Vorgaben und Richtlinien für die Pflege eines Bereiches der Kategorie “documentation”.

• Die Kategorie “collaboration” wird für Bereiche verwendet, in der Projektdokumentation erstellt wird.

Die Kategorie dient im Wesentlichen der Unterstützung des Gärtners bei der Pflege des Wiki.

LÖSUNG MIT CONFLUENCE

Weiterlesen auf https://confluence.atlassian.com/doc/organize-your-space-829076206.html

Case Bereich im Wiki ändern

AUSGANGSLAGE

Als Gärtner im Wiki möchte ich den für Leser sichtbaren Titel und das Logo des Bereiches ändern.

LÖSUNG MIT CONFLUENCE

Weiterlesen auf https://confluence.atlassian.com/doc/organize-your-space-829076206.html

Page 6: AGIL DOKUMENTIEREN MIT CARDS+ · 2017. 9. 9. · CARDS+ Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg,

CARDS+

Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg, deren Lösungen bundesweit zum Einsatz kommen. Unsere Lösungen sind von Beginn an qualitativ ausgereift, agil entwickelt, zukunftsfähig und mitwachsend – bei unserer Leidenschaft für neue Technologien können wir gar nicht anders.

© eMundo GmbH 2017 - www.e-mundo.de

Case Bereich im Wiki endgültig löschen

AUSGANGSLAGE

Als Gärtner im Wiki möchte ich einen bereits angelegten Bereich löschen. Alle im Bereich angelegten Seiten, Beiträge und Kommentare gehen verloren.

LÖSUNG MIT CONFLUENCE

Weiterlesen auf https://confluence.atlassian.com/doc/delete-a-space-139524.html

Epic Seite im Wiki

Motivation

Die Grundfunktion eines Wiki ist es, Seiten mit Inhalten bereitzustellen. Seiten bieten Grundfunktionen, bestehend aus mindestens sechs Überschriftenebenen, drei Absatzformaten (normal, für Code, für ein Zitat) und kombinierbaren Schriftstilen (fett, kursiv, unterstrichen,durchgestrichen).

Eine hierarchische Struktur der Seiten im Wiki ist zur Bewältigung von komplexen Inhalten unbedingt notwendig. Mit einer Hierarchie von Seiten und Unterseiten bilden wir die Strukturen innerhalb der Dokumentation ab.

Die Seitenhistorie gibt eine Übersicht, welcher Autor zu welchem Zeitpunkt eine Änderung an einer Seite gemacht hat.

Abgrenzung

Keine Angabe.

Case Seite im Wiki erstellen

AUSGANGSLAGE

Als Autor im Wiki möchte ich eine Seite mit einem Titel erstellen. Ich möchte Text eingeben. Für die Gestaltung des Textes möchte ich Funktionen wie fett, kursiv, unterstreichen und durchstreichen verwenden. Ich möchte den Text mit Überschriften mit mindestens drei Ebenen strukturieren.

Als Autor im Wiki möchte ich beliebig viele Seiten als Unterseite einer bestehenden Seite anlegen und bearbeiten.

LÖSUNG MIT CONFLUENCE

Weiterlesen auf https://confluence.atlassian.com/doc/create-and-edit-pages-139476.html

Case Seite im Wiki anzeigen

AUSGANGSLAGE

Als Autor oder Leser im Wiki möchte ich den Inhalt einer Seite sehen.

Als Autor im Wiki möchte ich Unterseiten in einer bestimmten Ordnung haben. Standardmäßig sollen Unterseiten alphabetisch geordnet sein. Alternativ erhält jede Unterseite eine feste Position. In einen eigenen Navigationsbereich werden Seiten und Unterseiten eines Bereiches hierarchisch angezeigt.

LÖSUNG MIT CONFLUENCE

Weiterlesen auf https://confluence.atlassian.com/doc/create-and-edit-pages-139476.html

Case Seite im Wiki mit einem Kommentar versehen

AUSGANGSLAGE

Als Autor oder Leser im Wiki möchte ich für eine Seite einen Kommentar eingeben oder auf einen existierenden Kommentar antworten.

Page 7: AGIL DOKUMENTIEREN MIT CARDS+ · 2017. 9. 9. · CARDS+ Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg,

CARDS+

Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg, deren Lösungen bundesweit zum Einsatz kommen. Unsere Lösungen sind von Beginn an qualitativ ausgereift, agil entwickelt, zukunftsfähig und mitwachsend – bei unserer Leidenschaft für neue Technologien können wir gar nicht anders.

© eMundo GmbH 2017 - www.e-mundo.de

LÖSUNG MIT CONFLUENCE

Weiterlesen auf https://confluence.atlassian.com/doc/comment-on-pages-and-blog-posts-139483.html

Case Seite im Wiki mit einem Schlagwort versehen

AUSGANGSLAGE

Als Autor im Wiki möchte ich für eine Seite eine Reihe von Schlagworten eingeben.

LÖSUNG MIT CONFLUENCE

Weiterlesen auf https://confluence.atlassian.com/doc/add-remove-and-search-for-labels-136419.html

Case Seite im Wiki ändern

AUSGANGSLAGE

Als Autor im Wiki möchte ich den Inhalt einer Seite ändern.

LÖSUNG MIT CONFLUENCE

Weiterlesen auf https://confluence.atlassian.com/doc/create-and-edit-pages-139476.html

Case Seite im Wiki umbenennen

AUSGANGSLAGE

Als Autor im Wiki möchte ich eine bereits angelegte Seite umbenennen, d.h. mit einem neuen Titel versehen.

LÖSUNG MIT CONFLUENCE

Weiterlesen auf https://confluence.atlassian.com/doc/create-and-edit-pages-139476.html

Case Seite im Wiki verschieben

AUSGANGSLAGE

Als Autor im Wiki möchte ich eine Unterseite verschieben, d.h. einer anderen Seite unterordnen.

LÖSUNG MIT CONFLUENCE

Weiterlesen auf https://confluence.atlassian.com/doc/create-and-edit-pages-139476.html

Case Seite im Wiki hervorheben

AUSGANGSLAGE

Als Leser im Wiki möchte ich eine Seite, die mir gefällt, besonders hervorheben.

LÖSUNG MIT CONFLUENCE

Weiterlesen auf https://confluence.atlassian.com/doc/likes-and-popular-content-278695530.html

Case Seite im Wiki löschen

AUSGANGSLAGE

Als Autor im Wiki möchte ich eine von mir angelegte Seite löschen.

Als Gärtner im Wiki möchte ich jede beliebige Seite löschen.

LÖSUNG MIT CONFLUENCE

Weiterlesen auf https://confluence.atlassian.com/doc/delete-or-restore-a-page-139429.html

Page 8: AGIL DOKUMENTIEREN MIT CARDS+ · 2017. 9. 9. · CARDS+ Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg,

CARDS+

Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg, deren Lösungen bundesweit zum Einsatz kommen. Unsere Lösungen sind von Beginn an qualitativ ausgereift, agil entwickelt, zukunftsfähig und mitwachsend – bei unserer Leidenschaft für neue Technologien können wir gar nicht anders.

© eMundo GmbH 2017 - www.e-mundo.de

Epic Seitenvorlage im Wiki

Motivation

Eine Seitenvorlage im Wiki ist wichtig für die Durchsetzung eines einheitlichen Formats bei der Gestaltung von Seiten. Sie gibt eine feste Struktur in Form von Überschriften vor. Sie kann wie jede normale Seite gestaltet werden. Eine Seitenvorlage definiert Schlagworte zur Kennzeichnung der daraus erzeugten Seiten. Anhand dieser Schlagworte können später die Seiten identifiziert werden, die aus dieser Seitenvorlage entstanden sind (der Stereotyp der Seite).

Abgrenzung

Nachträglich Änderungen an einer Seitenvorlage wirken sich nicht mehr auf bereits angelegte Seite aus.

Case Seitevorlage im Wiki erstellen

AUSGANGSLAGE

Als Gärtner im Wiki möchte ich eine Seitenvorlage mit einem Titel anlegen. Ich möchte Text eingeben. Für die Gestaltung des Textes möchte ich Funktionen wie fett, kursiv, unterstreichen und durchstreichen verwenden. Ich möchte den Text mit Überschriften mit mindestens drei Ebenen strukturieren.

LÖSUNG MIT CONFLUENCE

Weiterlesen auf https://confluence.atlassian.com/doc/create-a-template-296093779.html

Case Seitevorlage im Wiki ändern

AUSGANGSLAGE

Als Gärtner im Wiki möchte ich den Inhalt einer Seitenvorlage ändern.

LÖSUNG MIT CONFLUENCE

Weiterlesen auf https://confluence.atlassian.com/doc/create-a-template-296093779.html

Case Seitevorlage im Wiki mit einem Schlagwort versehen

AUSGANGSLAGE

Als Gärtner im Wiki möchte ich für eine Seitenvorlage Stichworte eingeben.

LÖSUNG MIT CONFLUENCE

Weiterlesen auf https://confluence.atlassian.com/doc/create-a-template-296093779.html

Case Seitevorlage im Wiki umbenennen

AUSGANGSLAGE

Als Gärtner im Wiki möchte ich eine bereits angelegte Seitenvorlage umbenennen, d.h. mit einem neuen Titel versehen.

LÖSUNG MIT CONFLUENCE

Weiterlesen auf https://confluence.atlassian.com/doc/create-a-template-296093779.html

Case Seitevorlage im Wiki verwenden

AUSGANGSLAGE

Als Autor im Wiki möchte ich eine aus einer Seitenvorlage eine neue Seite anlegen. Diese Stichworte der Seitenvorlage werden für die neue Seite übernommen.

Page 9: AGIL DOKUMENTIEREN MIT CARDS+ · 2017. 9. 9. · CARDS+ Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg,

CARDS+

Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg, deren Lösungen bundesweit zum Einsatz kommen. Unsere Lösungen sind von Beginn an qualitativ ausgereift, agil entwickelt, zukunftsfähig und mitwachsend – bei unserer Leidenschaft für neue Technologien können wir gar nicht anders.

© eMundo GmbH 2017 - www.e-mundo.de

LÖSUNG MIT CONFLUENCE

Weiterlesen auf https://confluence.atlassian.com/doc/create-a-template-296093779.html

Case Seitevorlage im Wiki endgültig löschen

AUSGANGSLAGE

Als Gärtner im Wiki möchte ich eine bereits angelegte Seitenvorlage löschen.

LÖSUNG MIT CONFLUENCE

Weiterlesen auf https://confluence.atlassian.com/doc/create-a-template-296093779.html

Epic Medien im Wiki

Motivation

Eine Medienbibliothek enthält alle Zusatzdokumente, die in anderen Formaten außerhalb des Wiki gepflegt werden. Für jedes Format in der Medienbibliothek gibt es eine Möglichkeit zur Integration in Seiten als Link. Zusätzlich können Bilder auch in einer Seite eingebettet werden.

Abgrenzung

Folgende Formate werden mindestens unterstützt:

• Portable Network Graphics (kurz PNG)

• Portable Document Format (kurz PDF).

Case Datei zur Medienbibliothek im Wiki hinzufügen

AUSGANGSLAGE

Als Autor im Wiki möchte ich eine beliebige Datei in die Medienbibliothek einfügen.

LÖSUNG MIT CONFLUENCE

Confluence erlaubt Anhänge in jeder Seite. Die Medienbibliothek in Confluence ist daher eine besondere Seite in der Produktdokumentation. Sie enthält Abbildungen und Diagramme, die in anderen Seiten verwendet werden. Ein weiteres Ziel ist es, unabhängig vom Werkzeug zur Bearbeitung für die Einbettung in den Seiten konsequent PNG-Dateien bereitzustellen.

Case Datei aus Medienbibliothek im Wiki mit einem Text verknüpfen

AUSGANGSLAGE

Als Autor im Wiki möchte ich einen Text einer Seite mit einem Link auf eine Datei aus der Medienbibliothek verknüpfen. Der verknüpfte Text wird optisch hervorgehoben, z.B. andere Farbe oder unterstrichen. Ein Klick auf den Link einer Datei, für die es einen internen Viewer gibt, öffnet die Anzeige der Datei. Im anderen Fall öffnet der Klick einen Dialog zum lokalen Speichern der Datei.

LÖSUNG MIT CONFLUENCE

Ein Text wird mit einem Link mit der Image-Seite verknüpft.

Weiterlesen auf https://confluence.atlassian.com/doc/links-776656293.html

Case Datei aus Medienbibliothek im Wiki in einer Seite einbetten

AUSGANGSLAGE

Als Autor im Wiki möchte ich eine Datei aus der Medienbibliothek in einer Seite einbetten. Beim Öffnen der Seite wird der Inhalt der Datei sofort angezeigt.

Page 10: AGIL DOKUMENTIEREN MIT CARDS+ · 2017. 9. 9. · CARDS+ Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg,

CARDS+

Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg, deren Lösungen bundesweit zum Einsatz kommen. Unsere Lösungen sind von Beginn an qualitativ ausgereift, agil entwickelt, zukunftsfähig und mitwachsend – bei unserer Leidenschaft für neue Technologien können wir gar nicht anders.

© eMundo GmbH 2017 - www.e-mundo.de

LÖSUNG MIT CONFLUENCE

Diagramme und Abbildungen werden über das Makro “Seite einschließen” eingefügt. Das Makro zeigt den Inhalt der Image-Seite dort an, wo das Makro eingefügt wurde.

Weiterlesen auf https://confluence.atlassian.com/doc/include-page-macro-139514.html

Case Datei aus Medienbibliothek im Wiki entfernen

AUSGANGSLAGE

Als Autor im Wiki möchte ich eine Datei aus der Medienbibliothek endgültig entfernen. Verknüpfungen in Seiten oder Beiträge werden dadurch nicht automatisch entfernt.

LÖSUNG MIT CONFLUENCE

Jede Datei ist im Anhang einer Image-Seite. Die Datei wird gelöscht, indem die Image-Seite gelöscht wird.

Weiterlesen auf https://confluence.atlassian.com/doc/delete-or-restore-a-page-139429.html

Epic Beitrag im Wiki

Motivation

Ein Beitrag ist eine Nachricht, die zu einem bestimmten Zeitpunkt erstellt wird. Sie kann wie eine Seite gestaltet werden. Alle Beiträge werden chronologisch geordnet auf der Startseite des Bereiches angezeigt.

Abgrenzung

Keine Angabe

Case Beitrag im Wiki erstellen

AUSGANGSLAGE

Als Autor im Wiki möchte ich einen Beitrag erstellen. Ich möchte Text eingeben. Für die Gestaltung des Textes möchte ich Funktionen wie fett, kursiv, unterstreichen und durchstreichen verwenden. Ich möchte den Text mit Überschriften mit mindestens drei Ebenen strukturieren.

LÖSUNG MIT CONFLUENCE

Weiterlesen auf https://confluence.atlassian.com/doc/blog-posts-834222533.html

Case Beitrag im Wiki ändern

AUSGANGSLAGE

Als Autor im Wiki möchte ich den Inhalt eines Beitrags ändern.

LÖSUNG MIT CONFLUENCE

Weiterlesen auf https://confluence.atlassian.com/doc/blog-posts-834222533.html

Case Beitrag im Wiki umbenennen

AUSGANGSLAGE

Als Autor im Wiki möchte ich eine bereits angelegten Beitrag umbenennen, d.h. mit einem neuen Titel versehen.

LÖSUNG MIT CONFLUENCE

Weiterlesen auf https://confluence.atlassian.com/doc/blog-posts-834222533.html

Page 11: AGIL DOKUMENTIEREN MIT CARDS+ · 2017. 9. 9. · CARDS+ Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg,

CARDS+

Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg, deren Lösungen bundesweit zum Einsatz kommen. Unsere Lösungen sind von Beginn an qualitativ ausgereift, agil entwickelt, zukunftsfähig und mitwachsend – bei unserer Leidenschaft für neue Technologien können wir gar nicht anders.

© eMundo GmbH 2017 - www.e-mundo.de

Case Beitrag im Wiki löschen

AUSGANGSLAGE

Als Autor im Wiki möchte ich einen von mit angelegten Beitrag löschen.

Als Gärtner im Wiki möchte ich jeden beliebigen Beitrag löschen.

LÖSUNG MIT CONFLUENCE

Weiterlesen auf https://confluence.atlassian.com/doc/blog-posts-834222533.html

Epic Verwaltung des Wiki

Motivation

Das Wiki wird von verschiedenen Nutzern verwendet. Sie müssen im Wiki namentlich bekannt gemacht werden. Die Nutzung des Wiki ist nur möglich, wenn der Nutzer angemeldet ist. Ein anonymer Zugriff ist nicht vorgesehen. Nutzer haben im Wiki verschiedene Rollen mit unterschiedlichen Berechtigungen zum Lesen, Kommentieren und Bearbeiten von Seiten und Beiträgen im Wiki.

Das Wiki wird von speziell berechtigten Nutzern, den Gärtnern, verwaltet. Sie übernehmen Aufgaben wie Datensicherung oder die Konfiguration des Produktes. Sie sind Ansprechpartner für die Nutzer bei Fragen oder Problemen im Zusammenhang mit dem Wiki.

Abgrenzung

Keine Angabe

Case Konto für einen Nutzer im Wiki anlegen

AUSGANGSLAGE

Als Gärtner im Wiki möchte ich ein Konto für einen Nutzer anlegen. Das Konto enthält

• eine eindeutige Bezeichnung für das Konto.

• den vollen Namen des Nutzers.

• eine Mail-Adresse des Nutzers.

• eine Telefonnummer des Nutzers (optional).

• ein Bild des Nutzers (optional).

Jeder Nutzer wird beim Anlegen mit der Rolle «reader» verbunden.

LÖSUNG MIT CONFLUENCE

Weiterlesen auf https://confluence.atlassian.com/doc/add-and-invite-users-138313.html

Case Konto für einen Nutzer im Wiki deaktivieren

AUSGANGSLAGE

Als Gärtner im Wiki möchte ich das Konto eines Nutzer für unbestimmte Zeit deaktivieren.

LÖSUNG MIT CONFLUENCE

Weiterlesen auf https://confluence.atlassian.com/doc/delete-or-disable-users-138318.html

Case Konto für einen Nutzer im Wiki aktivieren

AUSGANGSLAGE

Als Gärtner im Wiki möchte ich das Konto eines Nutzers ab sofort aktivieren.

Page 12: AGIL DOKUMENTIEREN MIT CARDS+ · 2017. 9. 9. · CARDS+ Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg,

CARDS+

Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg, deren Lösungen bundesweit zum Einsatz kommen. Unsere Lösungen sind von Beginn an qualitativ ausgereift, agil entwickelt, zukunftsfähig und mitwachsend – bei unserer Leidenschaft für neue Technologien können wir gar nicht anders.

© eMundo GmbH 2017 - www.e-mundo.de

LÖSUNG MIT CONFLUENCE

Weiterlesen auf https://confluence.atlassian.com/doc/delete-or-disable-users-138318.htm

Case Konto für einen Nutzer im Wiki endgültig löschen

AUSGANGSLAGE

Als Gärtner im Wiki möchte ich das Konto eines Nutzers endgültig löschen. Seiten und Beiträge, die der Nutzer angelegt hat, werden jedoch nicht gelöscht.

LÖSUNG MIT CONFLUENCE

Weiterlesen auf https://confluence.atlassian.com/doc/delete-or-disable-users-138318.htm

Case Rolle Leser mit einen Nutzer im Wiki verknüpfen

AUSGANGSLAGE

Als Gärtner im Wiki möchte ich das Konto eines Nutzers mit der Rolle «Leser» verknüpfen. Dadurch erhält der Nutzer die Rechte, alle unbeschränkten Seiten des Wiki zu lesen.

LÖSUNG MIT CONFLUENCE

Die Lösung basiert auf der Kombination von Gruppen und globalen Berechtigungen für den Bereich.

Für Hinweise zu Gruppen weiterlesen auf https://confluence.atlassian.com/doc/adding-or-removing-users-in-groups-138321.html

Für Hinweise zu Berechtigungen weiterlesen auf https://confluence.atlassian.com/doc/space-permissions-overview-139521.html

LÖSUNG MIT SCROLL-VERSIONS

Für die Rolle «Reader» weiterlesen auf https://help.k15t.com/scroll-versions/latest/roles-and-permissions-114105161.html

Case Rolle Autor mit einen Nutzer im Wiki verknüpfen

AUSGANGSLAGE

Als Gärtner im Wiki möchte ich das Konto eines Nutzers mit der Rolle «Autor» verbinden. Dadurch erhält der Nutzer die Rechte, alle unbeschränkten Seiten des Wiki zu lesen und zu kommentieren, neue Seiten anzulegen, Seiten zu ändern und zu löschen.

LÖSUNG MIT CONFLUENCE

Die Lösung basiert auf der Kombination von Gruppen und globalen Berechtigungen für den Bereich.

Für Hinweise zu Gruppen weiterlesen auf https://confluence.atlassian.com/doc/adding-or-removing-users-in-groups-138321.html

Für Hinweise zu Berechtigungen weiterlesen auf https://confluence.atlassian.com/doc/space-permissions-overview-139521.html

LÖSUNG MIT SCROLL-VERSIONS

Für die Rolle «Author» weiterlesen auf https://help.k15t.com/scroll-versions/latest/roles-and-permissions-114105161.html

Case Rolle Gärtner mit einen Nutzer im Wiki verknüpfen

AUSGANGSLAGE

Als Gärtner im Wiki möchte ich das Konto eines Nutzers mit der Rolle «Gärtner» verbinden. Dadurch erhält der Nutzer alle Rechte im Wiki, kann alle Seiten anzeigen, bearbeiten und löschen.

Page 13: AGIL DOKUMENTIEREN MIT CARDS+ · 2017. 9. 9. · CARDS+ Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg,

CARDS+

Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg, deren Lösungen bundesweit zum Einsatz kommen. Unsere Lösungen sind von Beginn an qualitativ ausgereift, agil entwickelt, zukunftsfähig und mitwachsend – bei unserer Leidenschaft für neue Technologien können wir gar nicht anders.

© eMundo GmbH 2017 - www.e-mundo.de

LÖSUNG MIT CONFLUENCE

Die Lösung basiert auf der Kombination von Gruppen und globalen Berechtigungen für den Bereich.

Für Hinweise zu Gruppen weiterlesen auf https://confluence.atlassian.com/doc/adding-or-removing-users-in-groups-138321.html

Für Hinweise zu Berechtigungen weiterlesen auf https://confluence.atlassian.com/doc/space-permissions-overview-139521.html

LÖSUNG MIT SCROLL-VERSIONS

Für die Rolle «Doc-Admin» weiterlesen auf https://help.k15t.com/scroll-versions/latest/roles-and-permissions-114105161.html

Case Nutzer im Wiki von einer Rolle trennen

AUSGANGSLAGE

Als Gärtner im Wiki möchte ich das Konto eines Nutzers von einer beliebigen Rolle trennen.

LÖSUNG MIT CONFLUENCE

Die Lösung basiert auf der Kombination von Gruppen und globalen Berechtigungen für den Bereich.

Für Hinweise zu Gruppen weiterlesen auf https://confluence.atlassian.com/doc/adding-or-removing-users-in-groups-138321.html

Für Hinweise zu Berechtigungen weiterlesen auf https://confluence.atlassian.com/doc/space-permissions-overview-139521.html

LÖSUNG MIT SCROLL-VERSIONS

Für die Verwaltung der Rollen weiterlesen auf https://help.k15t.com/scroll-versions/latest/roles-and-permissions-114105161.html

Page 14: AGIL DOKUMENTIEREN MIT CARDS+ · 2017. 9. 9. · CARDS+ Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg,

CARDS+

Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg, deren Lösungen bundesweit zum Einsatz kommen. Unsere Lösungen sind von Beginn an qualitativ ausgereift, agil entwickelt, zukunftsfähig und mitwachsend – bei unserer Leidenschaft für neue Technologien können wir gar nicht anders.

© eMundo GmbH 2017 - www.e-mundo.de

Architekturentwurf

Konzepte

Spec Dokumentation mit CARDS+

Überblick

Die Methode CARDS+ ist ein agiler Ansatz, um Wissensmanagement in Software-Projekten richtig zu organisieren und zielgerichtet und inkrementell zu dokumentieren. Mit einer festen Struktur in einem Wiki und Prinzipien und Praktiken der Entwickler bringen wir Effizienz und Qualität in die Erstellung und Pflege einer Produktdokumentation.

Abbildung des agilen Prozesses

Die wesentlichen Ziele der Methode sind:

• Einfache und schnelle Erfassung von Produktwissen.

• Formal und inhaltlich prüfbare Dokumentation.

• Verwendbar im Backlog-Management.

• Beschreibt das Produkt vollständig.

• Die Dokumentation ist am Ende eines Inkrementes “fertig”.

• Inhalte können einfach und sicher geändert werden.

CARDS+ hilft bei der Umsetzung des agilen Manifest, insbesondere geht es um den zweiten Punkt. Wir wollen nur das dokumentieren, was wir brauchen. Mit “wir” ist dabei die ganzeProjektorganisation gemeint.

Page 15: AGIL DOKUMENTIEREN MIT CARDS+ · 2017. 9. 9. · CARDS+ Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg,

CARDS+

Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg, deren Lösungen bundesweit zum Einsatz kommen. Unsere Lösungen sind von Beginn an qualitativ ausgereift, agil entwickelt, zukunftsfähig und mitwachsend – bei unserer Leidenschaft für neue Technologien können wir gar nicht anders.

© eMundo GmbH 2017 - www.e-mundo.de

CARDS+ gibt eine sehr einfache Struktur für eine Produktdokumentation vor. Die Methode definiert eine feste Struktur und einige wenige Bausteine für ein Glossar, eine Systembeschreibung und die Architekturdefinition. Die Systembeschreibung besteht mindestens aus Topic, Epic und Case. Die Architekturdefinition in seiner minimalen Form besteht aus Decision und Service. Eine Medienbibliothek sorgt für Ordnung in Bildern und Diagrammen. Weitere Informationsquellen außerhalb des Wiki werden durch eineLinksammlung eingebunden.

CARDS+ ist kein Prozess, lässt sich aber sehr gut in Scrum integrieren. Jedes Dokument hat eine Zielgruppe und kann zu einem bestimmten Zeitpunkt im Verlauf des Projektes abgeschlossen und geprüft werden.

Ein unverzichtbares Werkzeug ist Atlassian Confluence. Mit CARDS+ versuchen wir, den Begriff Dokumentation weiter zu fassen. Nicht nur die Seiten im Wiki, sondern auch Code und Tests gelten als Dokumentation. Mit verschiedenen Ansätzen stellen wir Artefakte der Entwickler und Tester als lesbare Dokumentation zur Verfügung. Das Wiki bildet das zentrale Verzeichnis für die gesamte Dokumentation, mit Such- und Kommentarfunktion.

Dynamische Sicht

Keine

Statische Sicht

Keine

Module

Atlassian Confluence

Überblick

Die Methode CARDS+ ist ein agiler Ansatz mit dem Ziel, Produktwissen strukturiert und mit hoher Qualität zu erfassen. Ohne Wiki wird die Umsetzung jedoch nicht gelingen. Confluence vom australischen Hersteller Atlassian ist so ein Wiki. Ein Confluence-Bereich ist sehr gut geeignet für den Aufbau einer Produktdokumentation. Confluence hat alle Funktionen, die notwendig sind für die Umsetzung der Methode CARDS+. Und mit dem Add-On-Konzept gibt es eine Vielzahl von Erweiterungsmöglichkeiten für das Wiki, z.B. Glossary, Scroll-Office, Scroll-Versions und die Integration von Gliffy, Draw.io oder Balsamiq.

Weiterlesen auf atlassian.com

Dynamische Sicht

Confluence ist ein professionelles Wiki der Firma Atlassian. Es ist leicht zu bedienen. Aufgrund seiner umfangreichen Anpassbarkeit kann Confluence in zahlreichen Branchen eingesetzt werden.

Statische Sicht

Confluence ist in Bereiche (Spaces) organisiert. In einem Bereich können beliebig viele Seiten (Pages) und Nachrichten (Posts) angelegt werden. Seiten können kommentiert werden.

Nicht-Funktionale Aspekte

BERECHTIGUNGEN

Confluence kann folgende drei Arten von Berechtigungen unterschieden: Globale Berechtigungen, bereichsbezogene Berechtigungen und Seitenberechtigungen. Diese Berechtigungen können an einzelne Nutzer oder an ganze Nutzergruppen vergeben werden. Ein wichtiges Merkmal der Rechteverwaltung ist deren additive Vergabe von Berechtigungen: den Nutzern von Confluence können Berechtigungen erteilt, aber nicht explizit entzogen werden.

Weiterlesen bei Sebastian Höhne

Page 16: AGIL DOKUMENTIEREN MIT CARDS+ · 2017. 9. 9. · CARDS+ Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg,

CARDS+

Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg, deren Lösungen bundesweit zum Einsatz kommen. Unsere Lösungen sind von Beginn an qualitativ ausgereift, agil entwickelt, zukunftsfähig und mitwachsend – bei unserer Leidenschaft für neue Technologien können wir gar nicht anders.

© eMundo GmbH 2017 - www.e-mundo.de

VERSCHLÜSSELUNG

Confluence kann mit HTTPS betrieben werden.

ROBUSTHEIT

Keine Angabe

SKALIERBARKEIT

Keine Angabe

LOGGING

Keine Angabe

MONITORING

Keine Angabe

DATENKONSISTENZ

Keine Angabe

Atlassian JIRA

Überblick

JIRA wird vom Hersteller als Werkzeug zur Vorgangs- und Projektverfolgung für agile Teams bezeichnet. Confluence ist ein ausgereiftes Produkt mit vielen Funktionen, die man für ein Wiki braucht. Die beiden Produkte der australischen Firma Atlassian bilden ein sehr leistungsfähiges Paar. Wir können mit JIRA sehr gut die Methode Scrum unterstützen, mit Vorgängen für das Backlog vom Typ Epic, Story und Sprint. Das Backlog-Management profitiert von den Möglichkeiten zur Abbildung von Abhängigkeiten von Stories untereinander, von Story zu Ersteller (Product-Owner) bzw. Bearbeiter (Team) und zum Produktwissen in Confluence. Die Einschätzung der Komplexität des Teams aus Refinement- und Planning-Meeting sichert der Product-Owner in der Story, als Grundlage für seine Planung. Der aktuelle Fortschritt wird mit einem Burn-Down-Diagramm dargestellt. JIRA hat noch viele weitere Funktionen für die “Prozesssicht”, für die Sicht auf den Weg des Scrum-Teams zum richtigen Produkt. JIRA beantwortet die Frage, wie wir unser Ziel erreichen.

Weiterlesen auf atlassian.com

Weiterlesen auf seibert-media.net

Weiterlesen bei Sebastian Höhne

Dynamische Sicht

JIRA ist eine professionelle Vorgangsverwaltung der Firma Atlassian. Mit JIRA lassen sich verschiedenste Arten von Vorgängen (z.B. Aufgaben, Anforderungen, Fehler, Supportanfragen) verwalten und deren Bearbeitung nachverfolgen. Aufgrund seiner umfangreichen Anpassbarkeit kann JIRA in zahlreichen Branchen eingesetzt werden.

Statische Sicht

In JIRA werden sogenannte issues erstellt. Sie sind die Bausteine eines JIRA-Projekts. Ein issue kann eine beliebige Tätigkeit beschreiben, die geschätzt werden kann. Das könnte eine Story, ein Bug, eine Programmieraufgabe, etc. in einem Projekt sein. Projekte sind in JIRA der Rahmen für Tätigkeit. Die Bearbeitung einer Tätigkeit kann einem bestimmten Ansatz wie Scrum oder Kanban folgen. Projekte können als sogenannte boards visualisiert werden.

Page 17: AGIL DOKUMENTIEREN MIT CARDS+ · 2017. 9. 9. · CARDS+ Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg,

CARDS+

Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg, deren Lösungen bundesweit zum Einsatz kommen. Unsere Lösungen sind von Beginn an qualitativ ausgereift, agil entwickelt, zukunftsfähig und mitwachsend – bei unserer Leidenschaft für neue Technologien können wir gar nicht anders.

© eMundo GmbH 2017 - www.e-mundo.de

Nicht-Funktionale Aspekte

BERECHTIGUNGEN

Das in JIRA umgesetzte Rechtekonzept besteht aus mehreren Komponenten, die stark voneinander abhängig sind und daher stets gemeinsam betrachtet werden sollten: Globale Berechtigungen, Berechtigungsschemas, Workflowberechtigungen und Sicherheitsschemas.

Weiterlesen bei Sebastian Höhne

VERSCHLÜSSELUNG

JIRA kann mit HTTPS betrieben werden.

ROBUSTHEIT

Keine Angabe

SKALIERBARKEIT

Keine Angabe

LOGGING

Keine Angabe

MONITORING

Keine Angabe

DATENKONSISTENZ

Keine Angabe

Page 18: AGIL DOKUMENTIEREN MIT CARDS+ · 2017. 9. 9. · CARDS+ Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg,

CARDS+

Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg, deren Lösungen bundesweit zum Einsatz kommen. Unsere Lösungen sind von Beginn an qualitativ ausgereift, agil entwickelt, zukunftsfähig und mitwachsend – bei unserer Leidenschaft für neue Technologien können wir gar nicht anders.

© eMundo GmbH 2017 - www.e-mundo.de

Glossar

0-9

A

Anforderung

Definition

Mit einer Anforderung drückt ein Stakeholder einen aus seiner Sicht wichtigen Bedarf an einer Erweiterung oder Änderung des Produktes aus. In der Analyse der Anforderung wollen Product-Owner, Business-Analysten und das cross-funktionale Team einen Einblick in das fachliche Problem bekommen und ein gemeinsames Verständnis über Ziele und Lösungen entwickeln. Wir machen uns auch Gedanken über die Auswirkungen der Umsetzung.

Andere Definitionen

Wikipedia

Eine Anforderung ist eine Aussage über die notwendige Beschaffenheit oder Fähigkeit, die ein System oder Systemteile erfüllen oder besitzen muss, um einen Vertrag zu erfüllen oder einer Norm, einer Spezifikation oder anderen, formell vorgegebenen Dokumenten zu entsprechen.

Weiterlesen auf wikipedia.org

Architekturdefinition

Definition

Die Architekturdefinition wird bestimmt durch unternehmensweite verbindliche Vorgaben:

• Entscheidungen für Hardware, Middleware oder Bibliotheken.

• Beschreibung des Systemkontextes.

• Übergreifende Konzepte (z.B. Sicherheit, Transaktionen, Logging, Monitoring).

• Spezifikationen für Schnittstellen (z.B. REST- oder Web-Service).

• Komponentenschnitt (z.B. Aufteilung von Diensten in Domänen).

• Schichtenmodell (z.B. Präsentation, Fassade, Logik oder Persistenz).

Ergänzt wird die Architekturdefinition um projektspezifische Unterlagen wie

• Programmierrichtlinien,

• Qualitätsvorgaben und

• Anleitungen.

Andere Definitionen

Wikipedia

Page 19: AGIL DOKUMENTIEREN MIT CARDS+ · 2017. 9. 9. · CARDS+ Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg,

CARDS+

Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg, deren Lösungen bundesweit zum Einsatz kommen. Unsere Lösungen sind von Beginn an qualitativ ausgereift, agil entwickelt, zukunftsfähig und mitwachsend – bei unserer Leidenschaft für neue Technologien können wir gar nicht anders.

© eMundo GmbH 2017 - www.e-mundo.de

Eine Softwarearchitektur ist einer der Architekturtypen in der Informatik und beschreibt die grundlegenden Komponenten und deren Zusammenspiel innerhalb eines Softwaresystems.

Weiterlesen auf wikipedia.org

Aufgabenbereich

Definition

Ein Aufgabenbereich beschreibt einen klar abgegrenzten Teil des Geschäftsfeldes des Unternehmens.

Ein Aufgabenbereich ist das Ergebnis von Entscheidungen im Projekt-Management. Die Umsetzung des Produktes muss sich innerhalb der Grenzen der Aufgabenbereiche bewegen.

Andere Definitionen

Wikipedia: Fachgebiet

Fachgebiet (auch Fachbereich oder Fachrichtung) ist das auf ein bestimmtes Wissensgebiet begrenzte Wissen.

Weiterlesen auf wikipedia.org

B

C

CARDS+

Definition

CARDS+ ist eine agile Methode für Wissensmanagement und inkrementelles Dokumentieren in der Software-Entwicklung. Ziel ist die Erstellung und Pflege einer Produktdokumentation.

Ansprechpartner für die Methode ist Robert Bruckbauer.

Andere Definitionen

Blog

Die Methode CARDS+ ist ein agiler Ansatz, um Wissensmanagement in Software-Projekten richtig zu organisieren und zielgerichtet und inkrementell zu dokumentieren. Mit einer festen Struktur in einem Wiki und Prinzipien und Praktiken der Entwickler bringen wir Effizienz und Qualität in die Erstellung und Pflege einer Produktdokumentation.

Weiterlesen auf cardsplus.info

D

Dienst

Definition

Ein Dienst ist Teil einer Komponenten und realisiert einen bestimmten technischen Teil.

Page 20: AGIL DOKUMENTIEREN MIT CARDS+ · 2017. 9. 9. · CARDS+ Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg,

CARDS+

Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg, deren Lösungen bundesweit zum Einsatz kommen. Unsere Lösungen sind von Beginn an qualitativ ausgereift, agil entwickelt, zukunftsfähig und mitwachsend – bei unserer Leidenschaft für neue Technologien können wir gar nicht anders.

© eMundo GmbH 2017 - www.e-mundo.de

Ein Dienst wird auf Grundlage eines technischen Konzeptes realisiert. Das kann beispielsweise

• ein Microservice mit Spring-Boot,

• eine Topologie in einer Storm-Infrastruktur oder

• eine EJB in einem Applikationsserver

sein.

Andere Definitionen

Wikipedia

Der Begriff Dienst (auch Service oder Daemon) beschreibt in der Informatik allgemein eine technische, autarke Einheit, die zusammenhängende Funktionalitäten zu einem Themenkomplex bündelt und über eine klar definierte Schnittstelle zur Verfügung stellt.

Weiterlesen auf wikipedia.org

Ein Webservice oder Webdienst ist eine Softwareanwendung, die über ein Netzwerk für die direkte Maschine-zu-Maschine-Interaktion bereitgestellt wird. Jeder Webservice besitzt einen Uniform Resource Identifier (URI), über den er eindeutig identifizierbar ist, sowie eine Schnittstellenbeschreibung in maschinenlesbarem Format (als XML-Artefakt, meist WSDL), die definiert, wie mit dem Webservice zu interagieren ist. Die Kommunikation kann (muss aber nicht) über Protokolle aus dem Internetkontext wie HTTP laufen und kann XML oder JSON basiert sein

Weiterlesen auf wikipedia.org

Microservices sind ein Architekturmuster der Informationstechnik, bei dem komplexe Anwendungssoftware aus kleinen, unabhängigen Prozessen komponiert wird, die untereinander mit sprachunabhängigen Programmierschnittstellen kommunizieren. Die Dienste sind klein, weitgehend entkoppelt und erledigen eine kleine Aufgabe. So ermöglichen sie einen modularen Aufbau von Anwendungssoftware.

Weiterlesen auf wikipedia.org

E

F

Fachklasse

Definition

Eine Fachklasse ist in erster Linie eine Begriffsdefinition. Im Unterschied zu einem Eintrag in einem Glossar definiert eine Fachklasse ganz konkret Eigenschaften und Relationen eines Informationsobjektes.

Andere Definitionen

Wikipedia

Ein Datenmodell ist ein Modell der zu beschreibenden und verarbeitenden Daten eines Anwendungsbereichs (z. B. Daten des Produktionsbereichs, des Rechnungswesens oder die Gesamtheit der Unternehmensdaten) und ihrer Beziehungen zueinander.

Weiterlesen auf wikipedia.org

Page 21: AGIL DOKUMENTIEREN MIT CARDS+ · 2017. 9. 9. · CARDS+ Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg,

CARDS+

Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg, deren Lösungen bundesweit zum Einsatz kommen. Unsere Lösungen sind von Beginn an qualitativ ausgereift, agil entwickelt, zukunftsfähig und mitwachsend – bei unserer Leidenschaft für neue Technologien können wir gar nicht anders.

© eMundo GmbH 2017 - www.e-mundo.de

G

H

I

J

K

Komponente

Definition

Eine Komponente ist eine Zusammenstellung von Diensten, die zusammen eine bestimmte Aufgabe im System übernehmen, z.B. eine Schnittstelle.

Andere Definitionen

Wikipedia

Eine Komponente ist im Kontext der Softwarearchitektur ein Teil einer Software, der mit anderen Softwareteilen gemäß den Regeln eines Komponentenmodells zusammenwirken kann.

Weiterlesen auf wikipedia.org

Konzept

Definition

Ein Konzept kapselt eine technische Beschreibung. Zum einen wird ein Konzept empfohlen, um wiederholte, gleiche Beschreibungen an einer Stelle zu zentralisieren. Zum anderen ist ein Konzept angeraten, um komplexe technische Lösungen zu beschreiben, etwa, wenn mehrere Komponenten gleichzeitig betroffen sind.

Falls obige Bedingungen nicht gegeben sind, bzw. eine technische Detaillierung gar nicht benötigt wird, dann ist auch kein Konzept anzulegen.

Andere Definitionen

Wikipedia

Bei der Planung von Vorhaben werden Konzepte entwickelt, um bestimmte Ziele zu erreichen. Ein Ziel könnte z.B. sein, eine Maschine so zu konstruieren, dass sie zu einem späteren Zeitpunkt für einen anderen Verwendungszweck umgebaut werden kann.

Weiterlesen auf wikipedia.org

Page 22: AGIL DOKUMENTIEREN MIT CARDS+ · 2017. 9. 9. · CARDS+ Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg,

CARDS+

Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg, deren Lösungen bundesweit zum Einsatz kommen. Unsere Lösungen sind von Beginn an qualitativ ausgereift, agil entwickelt, zukunftsfähig und mitwachsend – bei unserer Leidenschaft für neue Technologien können wir gar nicht anders.

© eMundo GmbH 2017 - www.e-mundo.de

Das DV-Konzept ist eine Detailspezifikation der notwendigen Daten und Datentransformationen und bildet die Basis für die nachfolgende Phase der Implementierung.

Weiterlesen auf wikipedia.org

L

M

Modul

Definition

Unter dem Begriff Modul versammeln sich Software-Produkte, die beim Aufbau eines individuellen Produktes genutzt werden. Dazu zählen Verzeichnisdienste (z.B. git, LDAP) Datenbanken, Message-Broker, Caches, Web-Server, Proxy-Server. Module können aber auch Werkzeuge und Bibliotheken sein, die in Komponenten des individuellen Produktes genutzt werden, z.B. Spring Boot, Docker, Gradle.

Andere Definitionen

Wikipedia

Modularität (auch Baustein- oder Baukastenprinzip) ist die Aufteilung eines Ganzen in Teile, die als Module, Komponenten, Bauelemente oder Bausteine bezeichnet werden. Bei geeigneter Form und Funktion können sie zusammengefügt werden oder über entsprechende Schnittstellen interagieren.

Weiterlesen auf wikipedia.org

Wirtschaftslexikon

Im Software Engineering ein Baustein eines Softwaresystems, der bei der Modularisierung entsteht, eine funktional geschlossene Einheit darstellt und einen bestimmten Dienst bereitstellt.

Weiterlesen auf wirtschaftslexikon.gabler.de

N

Nachricht

Definition

Die Nachricht ist die Grundlage für den nachrichten-orientieren Datenaustausch zwischen Diensten.

Andere Definitionen

Wikipedia

Nachricht bezeichnet alltagssprachlich den Inhalt einer Information. Die Mitteilung einer Nachricht ist die Benachrichtigung. In der Informationstheorie ist eine Nachricht eine Information, die sich quantitativ als Signal und qualitativ als bedeutungstragendes Zeichen oder Zeichenfolge beschreiben lässt. Sie wird im Prozess der Kommunikation nach Maßgabe eines Codes von einem Sender an einen Empfänger übermittelt. Für den Empfänger hat sie einen Neuigkeitswert und ruft über die Stimulation hinaus bei ihm eine interpretative Reaktion hervor.

Page 23: AGIL DOKUMENTIEREN MIT CARDS+ · 2017. 9. 9. · CARDS+ Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg,

CARDS+

Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg, deren Lösungen bundesweit zum Einsatz kommen. Unsere Lösungen sind von Beginn an qualitativ ausgereift, agil entwickelt, zukunftsfähig und mitwachsend – bei unserer Leidenschaft für neue Technologien können wir gar nicht anders.

© eMundo GmbH 2017 - www.e-mundo.de

Weiterlesen auf wikipedia.org

O

P

Produktdokumentation

Definition

Die Produktdokumentation umfasst das gesamte Wissen zu einem Produktinkrement. Es beschreibt den Zustand eines Produktes zu einem bestimmten Zeitpunkt.

Andere Definitionen

Blog

Zur Produktdokumentation zählen beispielsweise folgende Unterlagen

• Systembeschreibung

• Architekturdefinition

• Glossar

• Benutzerhandbuch

• Betriebshandbuch

• Konfigurationen

• Skripte

• Schemadefinitionen

• Lesbarer Code

• Akzeptanztests

• Integrationstests

Eine Produktdokumentation ist nicht auf das Wiki beschränkt. Die vollständige Dokumentation befindet sich in verschiedenen Medien, z.B.

• Dokumentenmanagementsystem

• Produktwissen im Wiki

• Repository für Code und Test

Die Produktdokumentation ist die exakt dazu passende Sammlung von fachlichem und technischem Wissen über das Produkt.

Weiterlesen auf cardsplus.info

Q

Page 24: AGIL DOKUMENTIEREN MIT CARDS+ · 2017. 9. 9. · CARDS+ Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg,

CARDS+

Die eMundo GmbH ist ein IT-Software-Haus mit Hauptsitz in München und Niederlassungen in Frankfurt, Ingolstadt und Salzburg, deren Lösungen bundesweit zum Einsatz kommen. Unsere Lösungen sind von Beginn an qualitativ ausgereift, agil entwickelt, zukunftsfähig und mitwachsend – bei unserer Leidenschaft für neue Technologien können wir gar nicht anders.

© eMundo GmbH 2017 - www.e-mundo.de

R

S

T

U

V

W

Wiki

Definition

Ein Wiki ist ein technisches System, mit dem Texte und Bilder für die Beschreibung eines Produktes strukturiert von einem Team erfasst werden.

Andere Definitionen

Wikipedia

Ein Wiki (hawaiisch für „schnell“), seltener auch WikiWiki oder WikiWeb genannt, ist ein Hypertextsystem für Webseiten, deren Inhalte von den Benutzern nicht nur gelesen, sondern auch online direkt im Webbrowser geändert werden können (Web-2.0-Anwendung). Das Ziel ist häufig, Erfahrung und Wissen gemeinschaftlich zu sammeln (kollektive Intelligenz) und in für die Zielgruppe verständlicher Form zu dokumentieren. Die Autoren erarbeiten hierzu gemeinschaftlich Texte, die ggf. durch Fotos oder andere Medien ergänzt werden (Kollaboratives Schreiben, E-Collaboration).

Weiterlesen auf wikipedia.org

XY

Z