Kapitel 15. Style Guides
Diese Arbeit wurde mithilfe von KI übersetzt. Wir freuen uns über dein Feedback und deine Kommentare: translation-feedback@oreilly.com
Da sich unsere Stylesheets von einer Liste deklarativer Anweisungen zu einem System von Variablen, Funktionen und Logik entwickeln, müssen wir sicherstellen, dass sich auch unser Dokumentationssystem weiterentwickelt. Hologram gibt uns alles an die Hand, was wir brauchen, um ein robustes Dokumentationssystem für unser Entwurfssystem zu erstellen. Es ermöglicht uns, unser System direkt in den Sass- oder JavaScript-Dateien, in denen wir unseren Code schreiben, mit Anmerkungen zu versehen. Die Anmerkungen werden von Hologram automatisch gesammelt und in eine durchsuchbare Website mit gerenderten Beispielen und dazugehörigen Codebeispielen verwandelt. Das bedeutet, dass wir nicht zwei getrennte Codebases pflegen - der Styleguide ist in das eigentliche Designsystem integriert. Es ist leicht zu erkennen, wenn ein Code ohne ausreichende Dokumentation geschrieben wurde .
Zusätzlich zur Systemdokumentation können wir mit Hologram Standard-Markdown-Dateien erstellen, die in unserem Styleguide durchsucht werden können. So können wir Einführungsdokumente, Projektregeln und -verfahren, Kontaktinformationen oder alles andere, was erfasst, organisiert und für das Team dargestellt werden muss, erstellen.
Werfen wir einen kurzen Blick auf die Einrichtung von Hologram und sehen uns dann einige Dokumentationsbeispiele an.
Hologram ist ein ...
Get Frontend-Architektur für Designsysteme now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.
