Metrik schnell erklärt

Metrik schnell erklärt

metrik

Ganz abstrakt gesprochen quantifizieren Metriken unterschiedliche Eigenschaften von Produkten oder Prozessen in einer zahlenmäßigen Abbildung – einer Maßzahl. Die Theorie besagt, dass aus so einer Maßzahl Schlussfolgerungen hinsichtlich der Qualität eines Produktes oder Prozesses gezogen werden. Über- oder unterschreitet die Maßzahl oder die Veränderung der Maßzahl einen Grenzwert, werden gegebenfalls vorher vereinbarte Maßnahmen eingeleitet.

Für den Bereich der Software-Entwicklung gibt es eine Reihe von Metriken, mit der die Qualität von Code beschrieben wird. Es gibt eine Vielzahl von Software-Produkten am Markt, die diese Maßzahlen berechnen können. Bei agiler Software-Entwicklung mit Scrum werden diese Werkzeuge gerne auch automatisiert eingesetzt. Die Ergebnisse spielen eine Rolle bei der Abnahme des Produktinkrementes durch den Product-Owner im Review-Meeting.

Mit der Methode CARDS+ wollen wir neben einem hochwertigen Produkt auch eine genau so hochwertige Produktdokumentation herstellen. Wie bei der Beurteilung von Code macht es darum Sinn, sich auch Metriken für die Qualität einer Dokumentation zu schaffen.

Eine wesentliche Voraussetzung für die Beurteilung der Vollständigkeit wird durch die Verwendung der Bausteine der Methode CARDS+ erfüllt. Besonders für die Bausteine der Systemstruktur lässt sich einfach durch zählen ein Abgleich mit der Implementierung erzielen. Wird eine Komponente durch ein git-Repisitory gespeichert, muss es für jede Seite vom Typ Domain genau ein Repository geben. Basiert ein System auf einer Microservice-Architektur mit Docker, dann gibt es für jede Seite vom Typ Service einen gleichnamigen Docker-Container. Wohlgemerkt, das sind nur zwei Beispiele. Aber die Idee ist immer gleich: Für jede technische Komponente gibt es eine korrespondierende Seite im Wiki. Die Verknüpfung zwischen Wiki und Code basiert alleine auf dem Namen der Komponente. Damit stellen wir sicher, dass wir das Wissen über die Systemstruktur im Wiki erfassen können.

Eine andere Metrik ergibt sich aus der Möglichkeit in einem Wiki, als Leser Kommentare in den Seiten zu hinterlassen. Unter der Voraussetzung, dass die Produktdokumentation aktiv für die Entwicklung genutzt wird, ist die Anzahl der Kommentare einer Seite ein Hinweis auf die Qualität. Um daraus aber eine Metrik zu machen, müssen die Autoren die Kommentare moderieren. Das bedeutet, dass ein Autor jeden Kommentar als wertvolles Feedback betrachtet. Ein Kommentar kann ein Hinweis auf einen Fehler oder eine Lücke sein. Nach der Überarbeitung der Seite aufgrund des Hinweises wird der Kommentar entfernt. Ein Kommentar kann aber auch eine Frage sein. Der Autor klärt die Frage durch einen Antwortkommentar oder durch ein direktes Gespräch und löscht im Anschluss den Kommentar. Mit dieser Praxis ergibt sich die Maßzahl der Anzahl Kommentare einer Seite. Der Wert 0 bedeutet, dass es keine bekannten Fehler, Lücken oder offene Punkte gibt, die Seite hat daher gute Qualität. Gibt es Kommentare, dann ist die Seite offensichtlich nicht fertig und muss bearbeitet werden.


Wikipedia: Software-Metrik

Eine Software-Metrik, oder kurz Metrik, ist eine (meist mathematische) Funktion, die eine Eigenschaft von Software in einen Zahlenwert, auch Maßzahl genannt, abbildet. Hierdurch werden formale Vergleichs- und Bewertungsmöglichkeiten geschaffen.


IEEE-Standard 1061: Software-Qualitätsmetrik

Eine Software-Qualitätsmetrik ist eine Funktion, die eine Software-Einheit in einem Zahlenwert abbildet. Dieser berechnete Wert ist interpretierbar als der Erfüllungsgrad eine Qualitätseigenschaft der Software-Einheit.