Anzeige
Anzeige
How-To
Artikel merken

Webprojekte: Mit Coded Styleguides zum besseren Überblick

Bessere Übersicht, einfacheres Testing: Das alles geht mit Coded Styleguides. Doch was genau verbirgt sich dahinter? Und wie kann ein Entwickler-Team sie am effektivsten einsetzen?

Von Henning Muszynski
7 Min. Lesezeit
Anzeige
Anzeige

(Abbildung: Shutterstock/ PR Image Factory)

Wenn eine Web-App nicht das tut, was sie soll, sind die Nutzer verärgert. Das Entwicklerteam, das die Anwendung ­verantwortet, muss den steigenden Nutzeransprüchen also stets gerecht werden. Zusätzlich kommen immer neue technische ­Anforderungen an Applikationen im Browser hinzu: ­Anwendungen, die einst klein und sauber gestartet sind, entwickeln sich immer mehr zu unwartbaren, grotesken Feature-Ansammlungen. Und die ­nächste Deadline steht oftmals bereits vor der Tür. Dabei drängen sich immer wieder ähnliche Fragen auf: Welche Komponenten ­existieren in meinem Projekt? Wie stelle ich sicher, dass sie wieder­verwendbar sind? Wie baue ich wartbare ­Features – und wie halte ich sie funktionstüchtig?

Anzeige
Anzeige

Einen möglichen Ausweg versprechen Coded Styleguides: Verzeichnisse von Komponenten in verschiedenen Zuständen. Ein typisches Beispiel könnte eine Button-Komponente sein. Ein Button kann die Zustände „primär“, „sekundär“, „deaktiviert“ oder „beschäftigt“ annehmen. In der Anwendung kann es mitunter schwierig sein, einen sekundären und beschäftigten Button zu finden, der gleichzeitig auch noch lange genug in diesem Zustand verharrt, um ihn zu analysieren. In einem Coded Styleguide wird dieser Button nun in seinen verschiedenen Zuständen dargestellt. Dadurch, dass die Darstellung isoliert erfolgt, lässt sich die Komponente ohne ihre Abhängigkeiten analysieren. Im Unterschied zu klassischen Styleguides, die sämtliche Design-Artefakte ­eines Projekts wie Typografie und Farbgebung berücksichtigen, ­konzentrieren sich Coded Styleguides ausschließlich auf diese funktionale Darstellung.

Weniger Daten nötig

Wenn sie aktiv und regelmäßig verwendet werden, sind Coded Styleguides eine lebendige Dokumentation aller Elemente eines Projektes. Sie liefern dem gesamten Team einen Überblick, wann und wie Komponenten verwendet werden sollten und in welchen Fällen andere Bestandteile zu bevorzugen sind. So verhindern sie, dass Komponenten mehrfach gebaut werden, und reduzieren das Code-Aufkommen eines Projektes deutlich. Ein geringerer Wartungs­aufwand und eine höhere Stabilität der verwendeten Komponenten sind die Folge.

Anzeige
Anzeige

Werden Coded Styleguides aktiv in den Entwicklungsprozess integriert, offenbart sich ein weiterer Vorteil: Entwickler beginnen, anders über Komponenten und ihre Schnittstellen mit der Außenwelt (API) nachzudenken. Teams entwickeln Komponenten mit minimalen Schnittstellenoberflächen, denn je weniger Daten konsumiert werden, desto geringer wird die Fehlerwahrscheinlichkeit. Statt also eine Komponente, die zum Beispiel einen Text darstellt, mit ihrer ganzen Business-Logik weiterzugeben, reicht es völlig, eben nur diesen Text an die Komponente zu leiten.

Anzeige
Anzeige

Ein Vorteil, der besonders Designern sehr am Herzen ­liegen dürfte, ist die Vereinheitlichung des Markenbildes und der Produkt­identität. Je länger an einem Projekt gearbeitet wird und je mehr Leute ihre Finger im Spiel haben, desto wahrscheinlicher ist es, dass von Standards abgewichen wird. So kann es passieren, dass statt des definierten Markenblaus ein leicht anderer Farbton verwendet wird, der vorher nicht definiert wurde. Ehe man sich versieht, werden aus einer Ausnahme zehn. All diese Abweichungen im eigentlichen Projekt zu finden, ist sehr schwer und aufwendig. Mit einem Coded Styleguide können alle Komponenten in Isolation betrachtet und fehlerhafte Farbnuancen schneller gefunden werden.

Zusätzlich wird das Vereinheitlichen von Schriftgrößen und Abständen vereinfacht, wenn man jede Komponente isoliert betrachten kann. Sobald ein Team Coded Styleguides regelmäßig nutzt, werden die Designer feststellen, dass sie nicht mehr jede Interaktion bis ins letzte Detail spezifizieren müssen.

Anzeige
Anzeige

Ein anderer positiver Effekt, den der Einsatz von Coded ­Styleguides mit sich bringt, ist die Unterstützung beim Testen. Ein elementares Element ist dabei die Wiederverwendung von Testdaten. Um zum Beispiel eine komplexe Kommentar­komponente zu testen, benötigt man Kommentar- und Nutzerdaten. Um die gleiche Komponente im Coded Styleguide darzustellen, werden die gleichen (Test-)Daten benötigt. Es reicht also, sie einmal zu definieren. Web-Applikationen werden häufig mittels „Snapshot Testing“-Verfahren getestet. Hierbei werden Komponenten in Textform transformiert und diese Textformen bei jedem Testdurchlauf mit dem vorherigen Durchlauf verglichen. Verändert sich die Textform in zwei aufeinanderfolgenden Durchläufen, gilt der Test als fehlgeschlagen. Statt textuelle Snapshots zu vergleichen, ist es mit Coded Styleguides möglich, echte Bilder (Screenshots) der Komponente zu machen und diese bei jedem Testdurchlauf Pixel für Pixel zu vergleichen. Dies gibt eine viel höhere Sicherheit, dass die Komponenten tatsächlich so aus­sehen wie sie aussehen sollen und nicht durch eine unzusammen­hängende Anpassung verändert wurden. Zwar sind solche Tests nicht neu und wurden auch nicht von Coded Styleguides erfunden, allerdings sind sie durch Coded Styleguides praktikabler und zuverlässiger geworden. Denn, statt die komplette Applikation zu starten, um einen Screenshot zu erzeugen, muss nur noch der Coded Styleguide (meist eine statische Website) gestartet werden. Weniger bewegliche Teile führen in diesem Fall zu einem stabileren Ergebnis mit weniger falschen Testergebnissen (False Negatives).

Werkstatt oder Ladenzeile

Die zahlreichen Tools und Bibliotheken für Coded Styleguides ­lassen sich grob in zwei Kategorien einteilen: Werkstätten und Ladenzeilen. Werkstattlösungen unterstützen dabei, Komponenten isoliert zu entwickeln sowie sie zu testen. Ladenzeilen­lösungen hingegen stellen die Präsentation von Komponenten und ihre verschiedenen Zustände in den Vordergrund. Sie eignen sich meist besser zur Dokumentation bestehender Komponenten. Soll also ein bestehendes Projekt umgearbeitet oder ein Team an eine neue Technologie herangeführt werden, ist eine Werkstattlösung vermutlich die bessere Wahl. Besteht bereits eine stabile Komponentenbasis oder ein Kundenprojekt soll verlängert werden, indem man die bisherige Arbeit ansprechend präsentiert, fällt die Wahl höchstwahrscheinlich auf eine Ladenzeilenlösung.

Styleguidist

Styleguidist ist eine Lösung, die sich eher auf die Ladenzeilen­charakteristik von Coded Styleguides konzentriert. Styleguidist wird als Open Source auf GitHub entwickelt und unterstützt ­momentan die UI-Frameworks React und Vue. Die Unter­stützung von weiteren Frameworks ist geplant, noch gibt es jedoch kein Datum.

Anzeige
Anzeige

Coded Styleguides wie Styleguidist erleichtern es, die Komponenten­übersicht bei größeren Webprojekten zu behalten. Styleguidist ist Open Source und unterstützt Frameworks wie React oder Vue. (Screenshot: Styleguidist)

Wie aber kommen meine Komponenten in den von ­Styleguidist erzeugten Styleguide? Hierzu verwendet Styleguidist Markdown-­Dateien. Zu jeder Komponente wird eine Markdown-Beschreibung angelegt. Erzeugt man innerhalb von Markdown einen Code-Block mit drei Backticks (`), kann in diesem Code-Block die Komponente referenziert werden. Styleguidist fügt die so ­referenzierten Komponenten dann automatisch dem Styleguide hinzu. Sollte die Komponente schon mit Code-Kommentaren versehen sein oder Proptypes verwenden, werden diese Informationen automatisch aus dem Quellcode extrahiert und auf Wunsch im Styleguide angezeigt.

Die Verwendung von Markdown bringt einige Vorteile mit sich: Das Textformat ist sehr zugänglich und erlaubt, dass nicht nur das Entwicklungsteam den Styleguide pflegt, sondern das gesamte Team mitwirken kann. Außerdem stehen alle Funktionen von Markdown zur Verfügung, zum Beispiel das Einbinden von Links, Bildern oder Textformatierungen.
Hier eine beispielhafte Markdown-Beschreibung einer Button-­Komponente:

Basic button:
Basic button: 
```js 
<Button> 
  Push Me 
</Button> 
```

Big pink button: 
``` js 
<<Button 
  size="large" 
  color="deeppink" 
>
  Lick Me 
</Button>
```

Styleguidist sieht in der Standardkonfiguration schon sehr ansprechend aus. Die Software verfügt über ein Inhaltsverzeichnis aller Komponenten und einer Suche auf der linken Seite sowie einer „endlos“ scrollenden Liste mit allen Komponenten auf der rechten Seite. Zu jeder Komponente wird auf Wunsch ein Live-Code-Editor angezeigt. Das bedeutet, sobald der Styleguide ­deployed wurde, kann jeder Nutzer die Komponenten auf eigenen Wunsch anpassen und testen. Zusätzlich ist Styleguidist komplett anpassbar: Nicht nur lassen sich die Farben an das eigene Produkt anpassen, auch können einzelne Funktionen an- und abgeschaltet werden.

Anzeige
Anzeige

Werkstattlösung: Storybook

Im Gegensatz zu Styleguidist ist Storybook eine Werkstatt­lösung. Ziel ist es also, Entwickler bei der Neu- und Weiter­entwicklung sowie bei der Wartung von Komponenten zu unterstützen. Gleichzeitig bietet Storybook eine Übersicht aller Komponenten in verschiedenen Zuständen an, wie es bei Coded Styleguides üblich ist. Storybook unterstützt nahezu jedes UI-Framework über React und React Native bis hin zu Angular und Vue und sogar Web Components. Anders als bei Styleguidist werden hier keine Markdown-Dateien verwendet, um die Komponenten darzustellen, sondern Storys: JavaScript-Module, deren Aufgabe es ist, die Komponente(n) darzustellen.

Storybook sieht in der Standardkonfiguration deutlich funktio­naler und damit auch weniger ansprechend aus als ­Styleguidist – was für eine Werkstattlösung im Vergleich zu ­einer Ladenzeilenlösung auch nicht ungewöhnlich ist. Während bei Styleguidist alles bereits vorkonfiguriert ist und über einzelne Einstellungen an- und abgeschaltet werden kann, baut Storybook auf einer Plugin-Architektur auf. Die Anpassung ist also mit mehr Arbeit verbunden. Auch birgt jedes Plugin versteckte Kosten, da es konfiguriert und aktualisiert werden muss. Richtig einge­richtet ist Storybook aber eine sehr mächtige Werkstattlösung, die es dem Entwicklungsteam ermöglicht, sich auf das Bauen
von robusten und wiederverwendbaren Komponenten zu ­konzentrieren.

Storybook hilft nicht nur dabei, Komponenten zu warten, sondern unterstützt generell bei der Neu- und Weiterentwicklung. (Screenshot: Storybook)

Storybook hilft nicht nur dabei, Komponenten zu warten, sondern unterstützt generell bei der Neu- und Weiterentwicklung. (Screenshot: Storybook)

Denn die Plugins in Storybook helfen dabei, Komponenten effektiver zu entwickeln: So existieren Plugins, die es erlauben, Tests automatisch auszuführen und die Testergebnisse ­direkt in der ­Story anzuzeigen. Außerdem können automatisiert ­Accessibility-Tests durchgeführt und Warnungen angezeigt werden, sollten einzelne Komponenten Accessibility-Best-Practices nicht befolgen. Auch das oben beschriebene Snapshot-Testing lässt sich über ein entsprechendes Plugin abwickeln.

Anzeige
Anzeige

Wer jetzt selbst in die Welt der Coded Styleguides eintauchen will, sollte sich also zunächst überlegen, ob eher eine Ladenzeile oder eine Werkstatt gebraucht wird. Ebenso wichtig wie die Auswahl des passenden Tools ist die Klärung der Frage, wie und wo das Entwicklerteam den Styleguide hostet: Existiert er nur als ein weiterer Ordner im Code-Projekt, ist die Gefahr hoch, dass er in Vergessenheit gerät und nicht mehr aktualisiert wird. Um sicherzustellen, dass er wirklich verwendet wird, sollte er jedem im Team – und gegebenenfalls sogar externen Mitarbeitern – schnell und einfach zugänglich sein.

Do it yourself? Genau prüfen.

Wer überlegt, seinen Coded Styleguide selbst zu entwickeln, sollte an dieser Stelle noch einmal in sich gehen: Die Entwicklungsressourcen in den meisten Teams sind knapp, Kunden und Nutzer wünschen sich, dass Bugs schnell gefixt und neue Funktionen hinzugefügt werden. Das sollte auch weiterhin die Kernaufgabe der Entwickler sein. Besonders, wenn man gerade erst beginnt, Coded Styleguides in das eigene Projekt und den Entwicklungsprozess zu integrieren, sind die Unbekannten zu groß, als dass sie das Risiko einer Eigenentwicklung rechtfertigen könnten. Viel sinnvoller ist es, sich bei den existierenden Lösungen zu bedienen. Am Ende des Tages gilt: Ein Coded Styleguide ist nicht das eigentliche Produkt, sondern lediglich ein Hilfsmittel, um ein besseres Produkt zu bauen. Jeder Manager, Designer oder Entwickler sollte die Ressourcen, die in den Styleguide investiert werden, anhand dieser Maxime bemessen. Die Entwicklung von neuen Funktionen und das Beheben von Fehlern für ein Jahr zu stoppen, nur um den „perfekten“ Styleguide zu bauen, ist sicher kein gutes Investment. Wie in modernen Entwicklungsprozessen üblich, sollten Teams auch hier agil vorgehen, heißt: von einer soliden Basis aus iterativ weiter gehen.

Mehr zu diesem Thema
Fast fertig!

Bitte klicke auf den Link in der Bestätigungsmail, um deine Anmeldung abzuschließen.

Du willst noch weitere Infos zum Newsletter? Jetzt mehr erfahren

Anzeige
Anzeige
Schreib den ersten Kommentar!
Bitte beachte unsere Community-Richtlinien

Wir freuen uns über kontroverse Diskussionen, die gerne auch mal hitzig geführt werden dürfen. Beleidigende, grob anstößige, rassistische und strafrechtlich relevante Äußerungen und Beiträge tolerieren wir nicht. Bitte achte darauf, dass du keine Texte veröffentlichst, für die du keine ausdrückliche Erlaubnis des Urhebers hast. Ebenfalls nicht erlaubt ist der Missbrauch der Webangebote unter t3n.de als Werbeplattform. Die Nennung von Produktnamen, Herstellern, Dienstleistern und Websites ist nur dann zulässig, wenn damit nicht vorrangig der Zweck der Werbung verfolgt wird. Wir behalten uns vor, Beiträge, die diese Regeln verletzen, zu löschen und Accounts zeitweilig oder auf Dauer zu sperren.

Trotz all dieser notwendigen Regeln: Diskutiere kontrovers, sage anderen deine Meinung, trage mit weiterführenden Informationen zum Wissensaustausch bei, aber bleibe dabei fair und respektiere die Meinung anderer. Wir wünschen Dir viel Spaß mit den Webangeboten von t3n und freuen uns auf spannende Beiträge.

Dein t3n-Team

Melde dich mit deinem t3n Account an oder fülle die unteren Felder aus.

Bitte schalte deinen Adblocker für t3n.de aus!
Hallo und herzlich willkommen bei t3n!

Bitte schalte deinen Adblocker für t3n.de aus, um diesen Artikel zu lesen.

Wir sind ein unabhängiger Publisher mit einem Team von mehr als 75 fantastischen Menschen, aber ohne riesigen Konzern im Rücken. Banner und ähnliche Werbemittel sind für unsere Finanzierung sehr wichtig.

Schon jetzt und im Namen der gesamten t3n-Crew: vielen Dank für deine Unterstützung! 🙌

Deine t3n-Crew

Anleitung zur Deaktivierung
Artikel merken

Bitte melde dich an, um diesen Artikel in deiner persönlichen Merkliste auf t3n zu speichern.

Jetzt registrieren und merken

Du hast schon einen t3n-Account? Hier anmelden

oder
Auf Mastodon teilen

Gib die URL deiner Mastodon-Instanz ein, um den Artikel zu teilen.

Anzeige
Anzeige