Dokumentation für ein Designsystem schreiben und aktuell halten
Zum Dokumentieren eines Designsystems. Legt fest, was hineingehört, teilt die Arbeit nach Priorität in Seiten, erklärt jede Komponente mit Was, Warum, Wann und Wie und prüft vor jeder Veröffentlichung, ob Dokumentation, Gestaltung und Code übereinstimmen.
Diese KI-Regeln verwenden
## Festlegen, was die Dokumentation abdeckt, von Prinzipien bis zu Komponenten
Dokumentieren Sie sowohl die immateriellen Grundlagen des Systems – Prinzipien, Entscheidungen und Arbeitsweisen – als auch seine konkreten Bestandteile: Muster, Komponenten, Nutzungsregeln und Umsetzungswerkzeuge. Machen Sie den Umfang vor dem Schreiben sichtbar, damit Auslassungen zu Aufgaben im Arbeitsvorrat statt zu Überraschungen werden.
## Die Dokumentation in Seiten aufteilen und dort beginnen, wo es am meisten hakt
Gliedern Sie die Arbeit in eigenständige Seiten. Priorisieren Sie zuerst Bereiche mit den größten Reibungsverlusten, danach häufig verwendete oder stark von Abhängigkeiten geprägte Komponenten. Verfolgen Sie den Fortschritt und prüfen Sie die Prioritäten erneut, wenn sich Einschränkungen ändern. Verwenden Sie ein Werkzeug, das das Team zuverlässig pflegen, durchsuchen und gemeinsam nutzen kann.
## Jede Komponente anhand von vier Fragen erklären
Beantworten Sie für jede Komponente vier Fragen: Was ist sie, einschließlich ihrer Zustände und Optionen? Warum sollte sie ähnlichen Alternativen vorgezogen werden? Wann ist sie aufgrund ihres Kontexts geeignet? Wie soll sie verwendet werden, einschließlich unterstützter Varianten, Beispiele sowie ausdrücklicher Gebote und Verbote?
## Zuerst für Gestaltung und Entwicklung schreiben, für andere kurz halten
Bedienen Sie Gestaltungs- und Entwicklungsteams zuerst mit klarem Verhalten, Entscheidungskriterien, Umsetzungsverweisen und Links zu Code oder Anwendungsbeispielen. Bieten Sie Produkt-, Qualitätssicherungs- und Forschungsrollen einen kürzeren Prüfweg. Übernehmen Sie bewährte Muster aus anderen Systemen, passen Sie sie jedoch an; funktionaler Zugang ist wichtiger als visuelle Perfektion.
## Vor jeder Veröffentlichung prüfen, ob Dokumentation, Gestaltung und Code übereinstimmen
Behandeln Sie Dokumentation als lebendiges Produkt. Prüfen Sie neue Komponenten und Leitlinien in Kritikrunden, bewerten Sie den Dokumentationsbedarf beim Projektstart, testen Sie Komponenten mit Nutzenden und Barrierefreiheitsprüfungen und bestätigen Sie vor der Freigabe die Übereinstimmung von Gestaltung, Code und Dokumentation. Ändern Sie Pflegeroutinen, wenn Belege zeigen, dass sie nicht funktionieren.