Kapitel 17. Red Hat Dokumentation
Diese Arbeit wurde mithilfe von KI übersetzt. Wir freuen uns über dein Feedback und deine Kommentare: translation-feedback@oreilly.com
Als ich auf auf den einjährigen Prozess der Entwicklung des neuen Designsystems für die Red Hat-Website zurückblickte, wurde mir klar, dass das gesamte Projekt mit dem Bedarf an Dokumentation begann und von da an wuchs. Der ursprüngliche Wunsch der Geschäftsführung war es, einen Styleguide mit den am häufigsten verwendeten Bändern für unsere Website zu entwickeln und sie anderen Red Hat-Webseiten zur Verfügung zu stellen. Es begann mit einer Handvoll Sass-Partials und einem Hologram-Styleguide, aber daraus wurde so viel mehr.
Stufe 1: Ein statischer Style Guide
Wie ich in Kapitel 15 geschrieben habe, ist Hologram ein Dokumentationswerkzeug, das nach speziell markierten Kommentarblöcken in deinem Code sucht und den Inhalt dieser Blöcke in einen Style Guide umwandelt. Nachdem ich von Nicole Sullivan von Hologram gehört hatte, war ich überzeugt, dass es das perfekte Werkzeug für uns sein würde, um die Layouts und Komponenten zu dokumentieren, die wir bauen.
Die Arbeit in Hologram war schnell und reibungslos. Für jede Komponente oder jedes Layout gab es einen eigenen Sass-Teil, sodass wir unseren Dokumentationsblock am Anfang jeder Datei platzierten. Die Dokumentation enthielt alles, von unseren Absichten für die Komponente über ihre Möglichkeiten und Grenzen bis hin zu einem Beispiel für das HTML-Markup. Das Markup ...
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.
