Basis Bedienelemente Polarion Projekt Schema ... - Polarion... · Tipps & Tricks 22 Zeilenumbruch...

Projektstart

POLARION® ALM™ Start-Up Training

Inhalt

Basis Bedienelemente

Projekt Schema

Administration

Spaces

Dokumente

Tipps & Tricks

Erste Schritte in PolarionDer erste Teil des Polarion Start-Up Trainings beschäftigt sich mit der noch unbekannten Web-Bedienoberfläche und der Polarion-Bedienphilosophie.

Nach dem Anlegen eines neuen Polarion Projektes gilt es ein paar Vorüberlegungen zu den zukünftigen Projektinhalten anzustellen. Auf Basis dieser

Überlegungen wird in dem erstellten Projekt eine übersichtliche Struktur aufgebaut, in welche die späteren Inhalte (Anforderungen, Spezifikationen, Tests,

etc.) eingebettet und einsortiert werden. Polarion bietet dem Benutzer zwei unterschiedliche Möglichkeiten seine

Projektdokumentation anzulegen. Bis vor wenigen Jahren gab es lediglich die Option, alle Daten direkt in die Polarion „Datenbank“ einzutragen. Über Filter und

Suchmasken wurden dann später die Inhalte wieder zur Ansicht und zur Bearbeitung herausgesucht. Das direkte Arbeiten in einer Datenbank hat jedoch

den großen Nachteil, dass es an jeglicher Struktur fehlt, an der sich ein menschliches Gehirn orientieren könnte.

Aus diesem Grund wurden in Polarion 2011die Dokumente eingeführt. Hier werden die Inhalte im üblichen dokumentenzentrischem Vorgehen angelegt und

gestaltet. Ein Großteil der alltäglichen Aufgaben wird später in der Dokumentenansicht erledigt. Dazu zählen nahezu alle Arbeiten, die mit der

Eingabe oder dem Editieren der Projektdokumentation zu tun haben.

Die vielen Best Practice Ansätze in diesen Schulungsunterlagen basieren auf mehrjähriger Coaching- und Trainingserfahrung im Bereich des

Anforderungsmanagements in Werkzeug und Methode,und aus den Erfahrungen der hauseigenen Entwicklungsmannschaft, welche

Polarion unter anderem in SIL4 Projekten erfolgreich einsetzt.

Polarion

Basis Bedienelemente 4

Erster Aufruf 4

Navigationsleiste 4

Arbeitsbereich 5

Projekte öffnen 5

Projekte erstellen 5

Vorüberlegungen zum Schema 8

Schema umsetzen 10 Administration in Polarion 10

Navigation in der Administration 11

Administration öffnen und verlassen 11Wechsel zwischen Lokal und Global 11

Spaces 12

Spaces anlegen 12Spaces umbenennen / löschen 13

Work Item Typen definieren 13

Einsatz von Dokumenten vorbereiten 15

Parent Linkbeziehung für die hierarchische Struktur 15Dokumente anlegen 16

Titel und Description in Dokumenten anzeigen 16Dokumente umbenennen / löschen / verschieben 17

Arbeiten in Dokumenten 17 Kapitelstruktur erstellen 17

Work Items erstellen 18

Work Items verschieben 19

Work Items löschen 19

Work Item Markierung aufheben 19

Work Items hierarchisch verknüpfen 20

Weitere Inhaltselemente 21

Inhaltsverzeichnisse 21Tabellen 21Diagramme 21Statische Links 21Listen 22Bilder 22Seitenumbruch beim Druck 22

TrainUnt - Polarion 2015 - 1.3 Projektstart - V1.0 Seite / 2 28

Inhaltsverzeichnis

Tipps & Tricks 22 Zeilenumbruch in der Description 22

Dateianhänge im Dokument 23

Kommentare 23

Projekt Templates 24

Eigene Projekt Templates bauen 24Projekt Template hochladen 26

Notizen 27


Basis BedienelementeErster Aufruf

Navigationsleiste


Nach dem Start eines Webbrowsers muss die Adresse des Polarion Servers in die Adresszeile eingegeben werden. Bei Testinstallationen auf dem eigenen Rechner ist dies in aller Regel:localhost/polarion oder 127.0.0.1/polarion

Danach sollte der Webbrowser die folgende Seite anzeigen:

Am linken Bildschirmrand befindet sich nun die Navigationsleiste. Mit Hilfe dieser Leiste werden Projekte angelegt und geöffnet. Des Weiteren dient sie zur Navigation und Suche innerhalb der Projekte.

Administrationsbereich / Shortcuts verwalten / Logout Hier geht es zur globalen- und projektbezogenen Administration. Ferner werden über diese Schaltfläche die schon vorhandenen Shortcuts, sowie die Benutzereinstellung verwaltet.

Shortcuts erstellen Neue Shortcuts können über diesen Button erstellt werden.

Homebutton Bringt den Benutzer immer wieder zu dieser “Default Repository“ Ansicht zurück, welche auch als „Repository Root“ bezeichnet wird.

Projekt Hier wird das aktuell, gewählte Projekt angezeigt. Ist kein Projekt selektiert, befindet man sich automatisch im Datenbankursprung (dem Default Repository) Des Weiteren werden über diese Schaltfläche neue Projekte angelegt.

Volltextsuche Dient der Suche innerhalb des Polarion Repositorys

Benutzer Zeigt den eingeloggten Benutzer und führt in das persönliche “Cockpit“.

Home Zeigt die Startseite eines selektierten Projektes an.

Arbeitsbereich

Projekte öffnen

Projekte erstellen


Der Rest des Browserfensters wird vom Arbeitsbereich ausgefüllt. Der Inhalt des Arbeitsbereiches richtet sich nach dem, was in der Navigation selektiert wurde (kontextsensitiv). Hier werden beispielsweise Dokumente oder Wikiseiten angezeigt und editiert, Work Items tabellarisch aufgelistet, die Detailansicht eines Work Items bearbeitet, administrative Einstellungen erledigt, uvm.

Über das DropDown Menü der Projekt Schaltfläche werden die zuletzt besuchten Elemente (Projekt oder Projektgruppe) angezeigt. Hat man sich das erste Mal eingeloggt, oder wurde das gesuchte Projekt lange Zeit nicht geöffnet, bekommt man über den Menüpunkt „Open Project or Project Group“ die komplette Ansicht aller Projekte.

Best Practice TipGleich zu Beginn sollten die „Project Group“ Elemente (grüne Ordner) dazu verwendet werden eine übersichtliche Struktur in der ersten Repository-Ebene zu erschaffen (Bspw. Sandbox, Templates, CustomerA, CustomerB, ....).

Über die “Create new Project“ Schaltfläche werden in Polarion neue Projekte angelegt. Diese befindet sich im DropDown Menü der Projekt Schaltfläche und im „Open Project or Project Group“ Menüpunkt.


Die ID eines Projektes wird später in jeder URL vorkommen. Somit verbieten sich an dieser Stelle Sonder- und Leerzeichen. Die Location entspricht einer Project Group. Existiert diese nicht, wird sie automatisch angelegt. Der Projektname steht hinter der Location und entspricht per default der Projekt ID. Bei Bedarf kann der Name geändert werden (mit Sonderzeichen, etc.).Der Tracker Prefix ist Teil der eindeutigen ID der späteren Work Items (Anforderungen, Spezifikationen, Tests, etc.). Ist die zukünftige Location / Project Group des

Projektes existent, die genaue Schreibweise aber vergessen, kann mit dem SVN Picker der passende Speicherort aus dem Repository gesucht werden.

A C H T U N GDie Projekt ID kann nach der Erstellung des Projektes nicht mehr geändert werden. Projektname, Location und Tracker Prefix dafür schon.

A C H T U N GDer Tracker Prefix sollte so kurz wie möglich und so prägnant wie möglich gewählt werden. Theoretisch kann jedes Projekt im Repository den gleichen Tracker Prefix erhalten. Um spätere Verwechslungen zu verhindern, sollte dies aber vermieden werden.

Project Templates sind in Polarion nichts anderes als Projektkopien. Ein Template kann daher sowohl administrative Einstellungen, als auch Inhalte bereitstellen. Die Chance, dass eines der bereits existierenden Templates ihre Anforderungen zu 100% erfüllt liegt bei ca. 1 : 1.000.000. Wir kommen daher nicht umhin, ein Projekt „from scratch“ zu konfigurieren (was in Polarion zum Glück schnell erledigt ist).


Nach einer letzten Kontrolle wird das Projekt in das SVN Repository geschrieben und indiziert. Das „Create New Project“ Fenster wird mit „Finish“ abgeschlossen. Danach bringt uns Polarion automatisch zur Startseite des gerade erstellten Projektes.

Vorüberlegungen zum Schema


Lastenheft

System Spezifikation

Modul Spezifikation

System Test

1

2

3

2

Bevor wir damit beginnen können unser Projekt in Polarion mit Leben zu füllen, sollten wir uns darüber Gedanken machen, was es in unserem Projekt für Arten von Informationen geben wird, die wir gerne dokumentieren möchten. Unser fiktives Akkuschrauber Projekt lehnt sich mit seinem Entwicklungsprozess an ein einfaches V-Modell an. Es gibt also Dokumente vom Typ „Lastenheft“, „System Spezifikation“ und „Modul Spezifikation“. All diese Dokumente beschreiben den Werdegang einer Anforderung zu einer detaillierten Lösung. Später wollen wir testen, ob die System Spezifikationen fehlerfrei umgesetzt wurden. Hierfür wird es im rechten Ast des V-Modells zusätzlich ein Dokument vom Typ „System Test“ geben.In realen Projekten wird die Anzahl der Dokumente schnell den zweistelligen Bereich überschreiten. Schon zu Beginn sollte es daher einfache Namenskonventionen und Regelungen zur einheitlichen Benamsung der Dokumente und anderen Elementen geben. Weiterhin sollten die Dokumente eines Projektes in eine Struktur gebettet werden, welche die Übersichtlichkeit und Verstehbarkeit erhöht. Bei der Konkurrenz (IBM Rational DOORS) hat es sich beispielsweise etabliert, das verwendete V-Modell durch eine Ordnerstruktur in der ersten Ebene eines Projektes nachzubilden. In Polarion verwenden wir für diese Aufgabe „Spaces“, welche man grob als Pendant zu den DOORS Ordnern bezeichnen könnte. Da Ordner und Spaces alphanumerisch sortiert werden, müssen für eine logische Reihenfolge die Namen der Spaces durch eine Nummerierung ergänzt werden. Eine mögliche, simple Regel wäre die folgende:Die linke Seite des V-Modells (Spezifikation / Implementation) erhält von oben beginnend eine fortlaufende Nummerierung mit vollen Zehnerpotenzen (10, 20, 30, ...). Auf die zugehörige Testebene wird einfach eine 5 aufaddiert. Verwendete Dokumente werden nun in diese einfache Ordnerstruktur einsortiert.

Wir haben nun festgelegt welche „Spaces“ (Ordner) für die Struktur notwendig sind und welche Dokumente es geben wird. Damit haben wir allerdings noch nicht alle grundlegenden Strukturelemente definiert. Unsere Anforderungen, Spezifikationen, Tests, etc. werden nicht einfach in die Dokumente geschrieben, sondern liegen in einer Art „Container“, welche dann in eine Dokumentenstruktur eingebettet werden.Diese Container werden in Polarion „Work Items“ genannt und sind vereinfacht betrachtet nichts anderes als Pakete, bestehend aus verschiedensten Attributen. Je nach Einsatzzweck benötigt solch ein Work Item ganz unterschiedliche Attribute. Ein „Test“ Work Item braucht beispielsweise Attribute für Testergebnis, Reihenfolge, erwartetes Ergebnis, Prüfer, etc.. Eine Anforderung benötigt das alles nicht, braucht aber wiederum ein Attribut für die „Gewichtung“. Wie man sieht, erfordert jeder Einsatzzweck einen darauf zugeschnittenen Work Item Typen. In Polarion können beliebig viele Work Item Typen definiert werden. Sie dienen als Bauvorlagen für die Work Items.


Weiterhin ist es unerlässlich unterschiedliche Work Item Typen zu benutzen, wenn eine Traceability aufgebaut werden soll. Nur zwischen verschiedenen Work Item Typen können Linkregeln definiert werden. Und nur durch Linkregeln erhält die spätere Traceabilityanalyse eine Aussagekraft. Da wir später Linkbeziehungen zwischen unseren Dokumenten verfolgen wollen, sollte also für jede Dokumentenkategorie ein eigener Work Item Typ definiert werden. Ein Lastenheft-Dokument enthält Anforderungen, eine System-Spezifikations-Dokument die System Spezifikationen, ein System-Test-Dokument die System Test Cases, usw....Ein Dokument benötigt immer mindestens einen zugewiesenen Work Item Typen. Alle anderen Work Item Typen können in diesem Dokument nicht abgelegt werden. In manchen Sonderfällen kann es auch erforderlich sein mehrere Work Item Typen für eine Dokumentenkategorie zuzuweisen. Beispielsweise soll ein Lastenheft die Work Item Typen „Funktionale Anforderung“ und „Nicht funktionale Anforderung“ enthalten. Durch diese Unterscheidung kann die Traceability der NFA in einen parallelen Zweig umgeleitet werden um über Archtitekturentscheidungen später wieder zum Hauptpfad zurückzukehren.

Space mit seinen Dokumenten

Dokument mit eingebetteten Work Items

Detailansicht eines Work Items mit seinen Attributen

Dokumentenzentrisches Arbeiten Best Practice TipRein theoretisch könnten wir komplett ohne Spaces und Dokumente arbeiten, ohne gravierende funktionale Einbußen zu bekommen. Ein Work Item kann in Polarion auch ohne Dokument existieren. Dokumente sind technisch gesehen lediglich Speicherorte für Work Items. Bis 2011 musste man dies sogar machen, da es Dokumente als Strukturelemente in Polarion noch gar nicht gab. Der Benutzer hatte nur eine Datenbank voller, verschiedener Work Items, die er mit Hilfe von Suchabfragen filterte. Das menschliche Gehirn braucht aber Strukturen und Muster, um komplexe Systeme einigermaßen zu begreifen. Aus diesem Grund sollte man es sich zur Regel machen, jedes Work Item in die Space- und Dokumentenstruktur einzugliedern.

Auch hier gibt es natürlich wieder Sonderfälle. Beispielsweise Work Items mit zeitlich begrenzter Aussagekraft. Ein Work Item vom Typ „ToDo“ ist solch ein Kandidat. Hier reicht dem Nutzer eine kurze Datenbankabfrage (zeige alle meine ToDo‘s in chronologischer Reihenfolge). Eine Einbettung in Dokumente ist hier nicht erforderlich.

Etymologie - Work Item InfoDer Begriff „Work Items“ hat eine historische Bewandtnis. Er rührt noch aus der Vergangenheit, als Polarion vorwiegend für das Workloadmanagement eingesetzt wurde. Das man mit der Grundfunktionalität „Verlinken von Containern“ auch Anforderungsmanagement betreiben kann ist hingegen eine jüngere Entdeckung Polarions. Aus heutiger Sicht wäre der neutrale Begriff „Artefakte“ (wie in DOORS Next Generation) sicherlich zutreffender als „Work Items“.

Schema umsetzen

Administration in Polarion


In Polarion gibt es zwei Stellen an denen ein Projekt konfiguriert werden kann. An oberster Stelle steht die „Globale Administration“. Wie der Name schon vermuten lässt, ist die Globale Administration im Polarion Repository einmalig und wirkt mit allen Einstellungen, die hier getätigt werden, auf alle Projekte. An zweiter Stelle steht die „Lokale Administration“ (projektspezifische), welche einem Projekt angehört und sich auch nur auf dieses auswirkt. Die Menüs und Einstellmöglichkeiten der beiden Administrationsebenen sind bis auf wenige Ausnahmen identisch. Existiert eine Einstellung jeweils in der globalen und in der lokalen Konfiguration, so dominiert stets die Lokale!

Lokal oder Global administrieren? Best Practice TipSollte ein Projekt lieber lokal oder global administriert werden? Oder wäre eine Mischung vielleicht das Richtige? Sind alle Projekte im Polarion Repository in ihrem Schema 100%ig identisch so ist die globale Administration das Mittel der Wahl. Einstellungen müssen nur einmalig gemacht werden und wirken sich automatisch auf alle Projekte aus. Gibt es marginale Unterschiede könnte eine Mischung von global und lokal die richtige Entscheidung sein. Sonderfälle würde man einfach mit einer lokalen Einstellung überschreiben. In der Theorie machen obige Ansätze Sinn. In der Praxis sind diese beiden Fälle aber leider kaum anzutreffen. Projekte sind, oder entwickeln sich oftmals sehr spezifisch. Weiterhin ist das Ändern einer globalen Einstellung immer ein kritisches Unterfangen. Hat man wirklich alle Auswirkungen in allen Projekten bedacht?

A C H T U N GEin weiteres Manko der globalen Administration ist das physikalische Trennen von Konfiguration und Inhalt. Ein lokal administriertes Projekt bildet im SVN Repository eine geschlossene Einheit. Wird auf der Basis dieses Projektes ein Template erstellt, so kopiert Polarion das Projekt aus dem Repository, inklusive seiner Inhalte (Spaces, Dokumente, Work Items, etc.) und der lokalen Administration. Liegt die Administration nur global vor, sind lediglich die Inhalte in das Template verschoben worden. In diesem Fall ist das Template nur auf diesem einen Polarion Server in Kombination mit der globalen Administration zu gebrauchen.

globaleAdministration

lokale Administration

Polarion - SVN Repository

Projekt

Die grobe Struktur (Spaces, Dokumente, Work Item Typen), in welche die späteren Inhalte eingesetzt werden, ist nun festgelegt. Für die Umsetzung der Vorüberlegungen ist es jetzt teilweise erforderlich die Administration von Polarion zu betreten.

Navigation in der AdministrationAdministration öffnen und verlassen

Wechsel zwischen Lokal und GlobalGlobale Administration Lokale Administration


Über das Pulldown Menü in der linken, oberen Ecke wird die Administration betreten.

Mit „Return to Portal“ verlässt man die Administration wieder.

Ob der Benutzer beim Aufruf der Administration nun in der globalen oder in einer lokalen Administration landet, hängt davon ab, an welcher Stelle er sich z.Z. im Repository aufhält. Befindet sich der Benutzer im Default Repository (Einstiegspunkt) so schickt ihn Polarion in die globale Administration. Ist hingegen ein Projekt ausgewählt, geht es in die lokale Administration des Projektes.

Die Administration muss nicht verlassen werden, um zwischen Global und Lokal zu wechseln. Über „Recent Projects“ oder „Open Project or Project Group“ kann auch innerhalb der Administrationsebene zwischen Projekt Administrationen und der globalen Administration gewechselt werden.

Die globale Administration erkennt man daran, dass anstelle eines Projektes das Default Repository angezeigt wird.

Bei einer lokalen Administration wird das jeweilige Projekt angezeigt. Zudem erscheint der Link zur globalen Administration.

Schneller konfigurieren mit Tortoise SVN Best Practice TipEinstellungen werden in Polarion über grafische Oberflächen getätigt und in Form von XML Dateien im Polarion SVN Repository abgelegt. Diese Konfigurationsdateien lassen sich auch über andere 3rd Party Tools (z.B. Tortoise SVN) manipulieren. Sollen aufwändige Einstellungen (z.B. ein Workflow) an mehreren Projekten vorgenommen werden, so kann die entsprechende Konfigurationsdatei einfach via Tortoise SVN kopiert werden. Auf diese Weise lässt sich eine Konfigurationsdatei auch schnell zwischen lokal und global verschieben. Bei einer Standardinstallation ist das SVN Repository unter der URL http://SERVER-URL/repo/ zu erreichen. Der Umgang mit Subversion und der Tortoise SVN Client sollten bei dieser Art der Konfiguration natürlich kein Neuland sein.

http://SERVER-URL/repo/

http://SERVER-URL/repo/

Spaces

Spaces anlegen


Spaces werden in Polarion genutzt, um Dokumente und Wikiseiten (seit Polarion 2015 auch Report und Info Seiten) logisch zu gruppieren. Darüber hinaus ist jeder Space auch gleichzeitig eine Wikiseite. Diese kann beispielsweise genutzt werden, um den Benutzer ein Inhaltsverzeichnis mit Erklärungen anzuzeigen. Bei der Gestaltung einer Wikiseite sind der Phantasie kaum Grenzen gesetzt. Mehr dazu in den weiterführenden Kapiteln zu diesem Thema.

Default Space InfoWenn wir ein neues Polarion Projekt betreten existiert dort lediglich der „Default Space“, welcher alle Dokumente und Wikiseiten aufnimmt, die keinem speziellen Space zugeordnet wurden. Die Wikioberfläche dieses Spaces ist gleichzeitig die Wikioberfläche der Startseite des Projektes. Aus diesen Gründen kann der Default Space nicht gelöscht werden.

Neue Spaces können mit Hilfe des „+“ Buttons im Documents & Pages Bereich angelegt werden. Der „Space Title“ ist später lediglich in der Navigation sichtbar. Der „Space Name“ entspricht der ID und wird unter Wasser für die Pfade genutzt.

A C H T U N GDer Space Name sollte keine Sonderzeichen und/oder Leerzeichen enthalten, da diese bei den späteren Suchabfragen Probleme bereiten.

InfoEin Verschachteln von Spaces ist leider nicht möglich.

Spaces umbenennen / löschen

Work Item Typen definieren


Jeder Space hat einen Index, welcher alle Inhalte auflistet. Hier besteht u.a. die Möglichkeit den Space Title zu ändern oder den Space zu löschen. Ein nachträgliches Ändern des Space Namens ist hingegen nicht möglich.

A C H T U N GBeim Löschen werden alle im Space befindlichen Dokumente und Wikiseiten mit dem Space gelöscht. Work Items aus den Dokumenten verbleiben nicht im Repository!

Work Item Typen werden in der Administration unter dem Menüpunkt „Work Items / Enumerations definiert. Ist noch keine Konfigurationsdatei (workitem-type-enum.xml) vorhanden, muss sie mit dem „Create“ Button angelegt werden.

Polarion hat die Eigenart, bereits existierende, globale Konfigurationen als Vorlage für die Lokalen zu verwenden. Die dadurch übernommenen Einträge werden aber nicht benötigt und können über das „Minussymbol“ auf der rechten Seite gelöscht werden.


Nach dem Leeren kann begonnen werden die neuen Work Item Typen anzulegen. Mit dem „Plus Symbol“ in der unteren, rechten Ecke werden bei Bedarf neue Reihen hinzugefügt.

Best Practice TipDer Work Item Typ wird in Polarion oftmals nur über das zugehörige Icon dargestellt. Aus diesem Grund sollten die gewählten Icons Rückschlüsse auf den Typen geben. Auch hier sind einfache Regeln von Vorteil (s/w für Modul Specs / blau für System Specs / usw.) Bei Bedarf können eigene Icons im 16 x 16 Pixel Format hochgeladen werden.

Best Practice TipDie Reihenfolge der Work Item Typen sollte sich an dem verwendeten Vorgehensmodell orientieren (oben die Anforderungen, dann die System Specs, Modul Specs., usw.). Sie entspricht der späteren Reihenfolge in der Bedienoberfläche. Die Reihenfolge kann mit den Pfeilsymbolen in der Konfiguration am rechten Rand geändert werden.

Best Practice TipDie ID eines Work Item Typen sollte sich von seinem Namen durch einfache Regeln (nur Kleinschreibung, UpperCamelCase, etc.) ableiten lassen. Sonderzeichen und Leerzeichen sind hier nicht erlaubt!

Nach dem Verlassen der Administration (Return to Project) sollten die neu definierten Work Item Typen unter dem Menüpunkt „Work Items“ aufgelistet werden. Achtung, die Liste expandiert nur, wenn der kleine Pfeil am linken Rand erfolgreich getroffen wurde!

Einsatz von Dokumenten vorbereiten

Parent Linkbeziehung für die hierarchische Struktur


In Polarion Dokumenten können die Inhaltselemente hierarchisch zueinander angeordnet werden. Eine Überschrift ist beispielsweise automatisch das Elternelement aller unter ihr stehenden Elemente (natürlich nur bis zur nächsten Überschrift der gleichen Hierarchiestufe). Auch Work Items können zueinander solche hierarchischen Beziehungen eingehen. Wenn neue Dokumente angelegt werden, fragt Polarion welcher Beziehungstyp im Hintergrund für die Hierarchie verwendet werden soll. In der Regel verwendet man hierfür die „Parent- / Child-Beziehung“, welche z.Z. noch nicht existiert und erst angelegt werden muss.

In der Konfiguration muss zuerst die „workitem-link-role-enum.xml“ erstellt werden.

Genau wie bei der Konfiguration der Work Item Typen übernimmt Polarion auch hier wieder die Einstellungen aus der globalen Konfiguration. Bis auf die „parent“ Beziehung kann die Tabelle komplett geleert werden.

A C H T U N GDas „Parent“ Häkchen sagt Polarion, dass dieser Linktyp für die hierarchischen Beziehungen innerhalb der Dokumente verantwortlich ist.

A C H T U N GDamit Linkregeln editiert oder angelegt werden können, muss vorher die entsprechende Zeile (Linktyp) in der oberen Tabelle selektiert werden.

InfoEine Linkbeziehung wird in Polarion je nach Blickrichtung anders benamst.

Durch Automatismen werden die „parent“ Linkbeziehungen bei der Arbeit in den Dokumenten im Hintergrund gesetzt. Die untere Link Regel (nur innerhalb eines Work Item Typen) gilt an dieser Stelle nur für die „parent“ Linkbeziehung.

Dokumente anlegen

Titel und Description in Dokumenten anzeigen


Neue Dokumente werden am schnellsten über den Index des entsprechenden Spaces angelegt.

Jedes Dokument benötigt bei der Erstellung einen zugewiesenen Work Item Typen. Da es sich hier um ein Lastenheft handelt, ist der erste Work Item Typ (Functional Requirement) bereits goldrichtig. Soll das Dokument mehrere Work Item Typen aufnehmen können, muss dieses später in der Dokumentenkonfiguration eingestellt werden.Die LinkRole ist für die besagte, hierarchische Struktur notwendig. Durch das „Parent“ Häkchen in der „Link Role“ Konfigurationsdatei ist bereits der richtige Beziehungstyp vorausgewählt.Bei Bedarf kann noch ein dokumentenspezifischer Prefix vergeben werden. Wird ein Work Item außerhalb eines Dokuments betrachtet, kann hierüber die Zuweisung zum jeweiligen Dokument erfolgen.

A C H T U N GDer Dokumentenname sollte keine Sonderzeichen und/oder Leerzeichen enthalten, da diese bei den späteren Suchabfragen Probleme bereiten.

Zu den wichtigsten Attributen eines Work Items zählen der Titel und die Description. Wie bereits zu erahnen ist, soll der Titel lediglich den Inhalt der Description in wenigen Worten zusammenfassen. In Dokumenten wird per default der Titel eines Work Items nicht angezeigt. Somit hat der Benutzer keinerlei Einfluss auf den Inhalt dieses Attributes. Da der Work Item Titel aber von elementarer Bedeutung ist (und somit nicht leer bleiben darf), kopiert Polarion einfach die ersten Zeichen der Description in den Titel. Das ist natürlich nur ein Notbehelf und sollte in jedem Dokument vermieden werden. Über den „Configure Work Item Presentation“ Menüpunkt kann dies geändert werden.

Dokumente umbenennen / löschen / verschieben

Arbeiten in Dokumenten

Kapitelstruktur erstellen


Dokumente lassen sich über den zugehörigen Index verschieben, umbenennen oder löschen. Nach dem Markieren des betroffenen Dokumentes werden die entsprechenden Schaltflächen aktiv.

A C H T U N GBeim Löschen werden alle im Dokument befindlichen Work Items ebenso unwiderruflich gelöscht.

In Polarion können Dokumente mit unterschiedlichen Arten von Inhaltselementen gefüllt werden. Zu den wichtigsten Elementen gehören die Work Items. Diese Elemente kann der Benutzer später verlinken und auch außerhalb des Dokumentes (bspw. über Wikiseiten, Table-/Treeview, etc.) betrachten oder sogar bearbeiten. Daneben gibt es noch Elemente wie Dokumententext, Tabellen, Listen und Bilder. Diese Elemente können nicht verlinkt werden und sind auch nur im Dokument sichtbar und editierbar.

Die Kapitelstruktur wird wie in regulären Textbeabeitungsprogrammen durch Überschriften unterschiedlicher Ebenen gebildet. Hierzu muss der Cursor in den umzuformatierenden Dokumententext gesetzt, und anschließend das passende Überschriftenformat aus der Werkzeugleiste selektiert werden.

InfoIn Dokumenten wird für eine Überschrift ein Work Item vom Typ „Heading“ erzeugt. Dieses erlaubt einer Überschrift eine „Parent“ Linkbeziehung mit den unter ihr stehenden Elementen (Work Items oder andere Überschriften) einzugehen.

Work Items erstellen


Neue Work Items können auf verschiedene Art und Weise erstellt werden.

2. Nach existierenden Work Items gleichen TypsSoll direkt nach einem existierenden Work Item ein Weiteres, gleichen Typs angelegt werden, so muss der Cursor an das Ende des vorhandenen Work Items gesetzt und die „Return“ Taste gedrückt werden.

Ein weiteres „Return“ in Folge lässt das ungespeicherte Work Item verschwinden. Der Cursor befindet sich wieder im Dokumententext.

1. An beliebige Stelle über die Werkzeugleiste……den Description-Text schreiben und den Cursor in dem Paragraphen belassen. Anschließend in der Werkzeugleiste auf das Work Item Symbol klicken. Ist das Dokument für mehrere Work Item Typen konfiguriert worden, findet man die weiteren Typen über das Dropdown-Menü.

Anschließend dem Work Item einen Titel geben.

Nach dem Abspeichern bekommt das Work Item seine endgültige ID.

Work Items verschieben

Work Items löschen

Work Item Markierung aufheben


Work Items werden über die Zwischenablage verschoben. Hierzu einfach das gesamte Work Item markieren. Anschließend per „Strg - X“ ausschneiden und an anderer Stelle im Dokument per „Strg - V“ wieder einfügen.

Work Items werden über ihr eigenes Drop-Down Menü gelöscht.

A C H T U N GDiese Aktion ist endgültig und kann mit Polarion Bordmitteln nicht wieder rückgängig gemacht werden.

Ein „Unmark“ verschiebt ein Work Item in den Papierkorb des Dokumentes und kann auf unterschiedliche Weise erzeugt werden.

1. Backspace (Rücklöschtaste)Das Work Item markieren und mit Backspace ein „Unmark“ ausführen.

Work Items hierarchisch verknüpfen


2. Work Item Drop-Down MenüÜber das Work Item Menü ein „Unmark“ ausführen. Bei dieser Variante wandert das betroffene Work Item in den Papierkorb. Anstelle des Work Items wird der Titel und die Description als Dokumententext angezeigt.

Unmark rückgängig machenDer Papierkorb eines Dokumentes kann über die Werkzeugleiste eingeblendet werden. Enthaltene Work Items können markiert und via „Insert“ wieder in das Dokument geschoben werden.

A C H T U N GDie Linkbeziehungen von Work Items werden auch nach einem „Unmark“ noch in den Traceability Analysen angezeigt. Daher ist die „Unmark“ Funktionalität in der Praxis nicht zu empfehlen!

Work Items können miteinander hierarchisch in Beziehung gesetzt werden. Polarion nutzt dazu im Hintergrund die „Parent“ Linkbeziehung, welche auch von den Überschriften der Dokumente verwendet werden. In den Dokumenten wird ein hierarchisch untergeordnetes Work Item durch eine Einrückung symbolisiert.Per „Tabulator“ Taste wird ein markiertes Work Item eingerückt. Ein „Shift + Tab“ macht die Einrückung wieder rückgängig.

A C H T U N GDurch die Darstellung einer hierarchischen Verknüpfung wird dem Leser des Dokumentes lediglich die Unterordnung eines Work Items symbolisiert. Dies hat jedoch keinerlei Einfluss auf irgendein Vorgehen im Anforderungsmanagement. Wird die Spezifikation AD-208 in das satisfies / erfüllt Linkgeflecht eingebunden, bleiben AD-209 und AD-210 trotz hierarchischer Zugehörigkeit in den Linkanalysen unberücksichtigt.

Weitere Inhaltselemente

Inhaltsverzeichnisse

Tabellen

Diagramme

Statische Links


Neben Work Items, Überschriften und Dokumententext können noch andere Elemente in das Dokument eingearbeitet werden. Der Cursor muss bei allen Elementen zuvor an die gewünschte Position gebracht werden. Anschließend ist das entsprechende Inhaltselement in der Werkzeugleiste zu wählen.

Inhaltsverzeichnisse werden automatisch generiert und aktualisiert. Die Einträge dienen zugleich als Link zu den zugehörigen Kapiteln.

Tabellen können in Polarion entweder in den Dokumententext oder aber in die Description eines Work Items geschrieben werden. Somit ist es nur möglich eine komplette Tabelle in das spätere Linkgeflecht einzubauen. Eine Traceability auf der Filigranitätsstufe einer Tabellenzelle (wie bspw. in Rational DOORS) ist mit Polarion nicht möglich.

Polarion hat einen eingebauten Diagrammeditor, welcher auf einer kommerziellen Lösung (mxGraph) eines anderen Anbieters basiert. Mit diesem Editor lassen sich einfache Zeichnungen und Diagramme jedweder Art schnell in eine Work Item Description oder aber in den Dokumententext setzen.

A C H T U N GDieser Editor ist nur als Notbehelf für Zeichnungen mit wenigen Elementen zu gebrauchen. Komplexe UML / SysML Diagramme sollten immer mit einem dafür geschaffenem Werkzeug (Enterprise Architect oder besser Rational Rhapsody) erstellt werden.

Bei Bedarf können auch statische Links in den Dokumententext oder die Work Item Description geschrieben werden.

Listen

Bilder

Seitenumbruch beim Druck

Tipps & TricksZeilenumbruch in der Description


Soll in der Description eines Work Items ein Zeilenumbruch erfolgen so geht dies innerhalb eines Dokumentes nur über ein „Carriage Return“ (zu deutsch Wagenrücklauf). Bei einem einfachen Return erstellt Polarion direkt unter dem aktuellen Work Item ein weiteres. Der einfache Zeilenumbruch wird genau wie in der Textverarbeitung üblich, über ein „Shift + Return“ ausgelöst.

Listen können im Dokumententext oder in einer Work Item Description angelegt werden. Es stehen Bullet-Listen oder nummerierte Listen zur Auswahl

Bilder können im Dokument an beliebiger Stelle platziert und skaliert werden. Über eine Auswahlliste lassen sich bereits hochgeladene Bilder an weiteren Stellen einbinden. Durch Markieren und Löschen (Backspace Taste) werden Bilder nur aus der Ansicht entfernt. Im SVN Repository bleibt die Bilddatei weiterhin gespeichert.

Damit beim Druck eines Dokumentes die Inhalte nicht durch einen automatischen Seitenumbruch an unvorteilhaften Stellen auseinandergerissen werden, gibt es die Möglichkeit einen kontrollierten Umbruch an selbst definierter Stelle einzufügen.

Dateianhänge im Dokument

Kommentare


Oftmals sollen in einem Polarion Dokument Dateianhänge (Zip-Dateien, PDF‘s, etc.) hinterlegt werden. Die einzigen externen Dateien, die direkt in ein Dokument eingebunden werden können sind jedoch Bilder. Work Items können hingegen Dateianhänge jeglichen Formates aufnehmen. Um diese Dateianhänge dann innerhalb eines Dokumentes sichtbar zu machen, muss allerdings vorher unter dem „Configure Work Items Presentation“ Menüpunkt das Attribut „attachments“ eingetragen werden.

Über die Detailansicht eines Work Items kann der Benutzer die Dateianhänge hochladen.

Nach dem Abspeichern des Work Items erscheint die angehängte Datei auch im Dokument. Leider wird bei allen Work Items ohne Dateianhang ein „N/A“ (Not Available) angezeigt.

Kommentare oder ganze Diskussionsverläufe können an beliebiger Stelle im Description Text oder im Dokumententext eingefügt werden. Als Platzhalter wird ein kleines Indikator-Symbol angezeigt. Über „Reply“ können sich weitere Teilnehmer in eine Diskussion einklinken.

Das Indikator-Symbol verschwindet, sobald jemand den Kommentar mit einem „Resolve“ für gelöst erklärt. Über den Menüpunkt „Show Resolved Comments“ können gelöste Kommentare wieder in die Ansicht geholt und bei Bedarf wieder geöffnet (Reopen) werden.

Projekt Templates

Eigene Projekt Templates bauen


Polarion versucht den Benutzer beim Erstellen neuer Projekte mit vorgefertigten Projektvorlagen unter die Arme zu greifen. Diese Vorlagen bestehen aus lokalen Projektkonfigurationen (Work Item Typen, Workflows, Linkbeziehungen, Extra-Attribute,…) und Inhalten (Spaces, Dokumente, Wiki Seiten, Work Items,…).Diese „Standard“ Templates eignen sich jedoch allenfalls um sich Anreize und Ideen für die Gestaltung der eigenen Projekte zu holen. Niemals wird eine vorgefertigte Konfiguration exakt auf die eigenen Bedürfnisse zutreffen. Zum Glück sind eigene Templates in Polarion schnell erstellt, da sie leidlich aus einer Kopie der aktuellen SVN Projekt - Revision bestehen. Ein Template kann somit schnell aus jedem bereits existierenden Polarion Projekt gebaut werden.

Ist das gewünschte Projekt in Polarion geöffnet kann über die Navigation der „Repository Browser“ aufgerufen werden. Der Repository Browser springt automatisch an die Position des aktuellen Projektes innerhalb der SVN Datenbank. Mit einem Klick auf die „Download“ Schaltfläche werden die nun angezeigten Ordner:.polarion -> lokale Konfiguration _wiki -> Wikiseiten modules -> Dokumente und Work Items…in eine Zip Datei gepackt und heruntergeladen.

Best Practice TipProfis können selbstverständlich auch andere Software verwenden, um an die Daten des Polarion SVN zu kommen. Beispielsweise ein TortoiseSVN Client.

Die Inhalte der heruntergeladenen Zip Datei werden nun in einem neuen Ordner entpackt. Der Name des Ordners spielt eine untergeordnete Rolle. Er wird in Polarion an keiner Stelle angezeigt.

In den soeben erstellten Ordner wird nun eine Textdatei mit dem Namen „template.properties“ angelegt.

template.properties anpassen


name=Name des Templatesdescription=Hier steht die Beschreibung. Ein / erzeugt ein Zeilenumbruch!process=.polarion/polarion-project.xmltrackerPrefixToReplace=ADdistributions=ALM;QA;Requirements

Die „template.properties“ Datei beinhaltet mehrere Informationen über das Template.

name Hier steht der Name des Templates. Dieser String wird dem Benutzer beim Erstellen eines Projektes in der Template Vorauswahl angezeigt.

description Diese ausführliche Beschreibung des Templates wird angezeigt, sobald der Benutzer beim Erstellen eines Projektes das Template ausgewählt hat.

process Relativer Pfad zur „polarion-project.xml“. Wenn diese Datei nicht nachträglich verschoben wurde, muss der Pfad nicht angepasst werden.

trackerPrefixToReplace Neben den administrativen Einstellungen können Templates auch bereits erstellte Work Items enthalten. Diese Work Items besitzen aber bereits einen Präfix (z.B. AD-214), welcher erst in den neuen Projektpräfix umgeschrieben werden muss. Der „trackerPrefixToReplace“ gibt also an, welchen Präfix Polarion suchen und ersetzen muss.

distributions Definiert welche Polarion Lizenz für das Template erforderlich ist. Ein Template welches sich beispielsweise nur mit Testmanagement (also Polarion QA) beschäftigt, sollte sich nicht mit einer Polarion „Requirements“ Lizenz verwenden lassen, da die QA Funktion eh nicht genutzt werden könnte.

Info

Auch nach dem Hochladen des Templates können die bereits getätigten Einstellungen in der „template.properties“ Datei noch ediert werden. Hierzu muss das Template in der globalen Administration zuerst selektiert werden. Anschließend lässt sich über die „Properties“ Schaltfläche die Konfigurationsdatei in einem PopUp Fenster editieren.

Projekt Template hochladen


Abschließend muss das Template noch in das Zip Format gepackt werden.

In der globalen Administration kann das Template nun unter dem Menüpunkt „Project Templates“ hochgeladen werden.

Best Practice TipProjekt Templates sollten permanent gepflegt und dokumentiert werden. Es empfiehlt sich einen eigenen Projektordner für die Template Vorlagen anzulegen. Hier können die Templates schnell aktualisiert und anschließend wie zuvor beschrieben in eine Polarion Projekt Template Zipdatei übertragen werden. Weiterhin ist es auch sinnvoll die Templates mit einer Versionsnummer auszustatten. Änderungen sollten stets in einem „ChangeLog“ abgespeichert werden, welcher sich beispielsweise auf einer Wikiseite im „DefaultRepository“ befindet.

Notizen



Autor: Marco Matuschek

Herausgeber: WILLERT SOFTWARE TOOLS GMBH

Hannoversche Str. 2131675 Bü[email protected]+49 5722 / 9678 60

Polarion, Polarion Software, Polarion ALM, Polarion ALM Enterprise, Polarion ALM Pro, and Polarion Track & Wiki are worldwide trademarks or registered trademarks of Polarion SoftwareMS Word® is a registered trademark of Microsoft CorporationGrafik zur Cover-Gestaltung lizenziert über iStockphoto.com

Produkt: POLARION® ALM™ Start-Up Training

mailto:[email protected]

mailto:[email protected]

Basis Bedienelemente Polarion Projekt Schema ... - Polarion... · Tipps & Tricks 22 Zeilenumbruch...

Documents

Transcript of Basis Bedienelemente Polarion Projekt Schema ... - Polarion... · Tipps & Tricks 22 Zeilenumbruch...