How-To

Webprojekte: Mit Coded Styleguides zum besseren Überblick

Seite 2 / 2

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.

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.

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.

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

Schreib den ersten Kommentar!

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

Bitte schalte deinen Adblocker für t3n.de aus!

Hey du! Schön, dass du hier bist. 😊

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

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

Danke für deine Unterstützung.

Digitales High Five,
Stephan Dörner (Chefredakteur t3n.de) & das gesamte t3n-Team

Anleitung zur Deaktivierung