Anleitung zur Dokumentation einer CSS-Eigenschaft

Zunächst müssen Sie die CSS-Eigenschaft festlegen, die Sie dokumentieren möchten. Vielleicht haben Sie bemerkt, dass eine Seite fehlt, oder Sie haben fehlenden Inhalt in unserer Problemliste gesehen. Für genauere Informationen über die CSS-Eigenschaft müssen Sie eine relevante Spezifikation dafür finden (z.B. eine W3C-Spezifikation oder einen Fehlerbericht für eine nicht standardisierte Eigenschaft, die in Rendering-Engines wie Gecko oder Blink verwendet wird).

Falls Implementierung und Spezifikation voneinander abweichen, zögern Sie nicht, dies im Implementierungsfehler zu erwähnen. Eine der folgenden Situationen ist möglich:

• Es könnte ein Fehler in der Implementierung sein (und ein Folgefehler wird erstellt).
• Es könnte eine Verzögerung bei der Veröffentlichung einer neuen Spezifikation sein.
• Es könnte ein Fehler in der Spezifikation sein (in diesem Fall lohnt es sich, einen Spezifikationsfehler zu melden).

Mehrere Merkmale einer CSS-Eigenschaft, wie ihre Syntax oder ob sie animiert werden kann, werden auf mehreren Seiten erwähnt und daher in einer speziellen Datenbank gespeichert. Makros, die Sie auf der Seite verwenden, benötigen Informationen über die Eigenschaft, die dort gespeichert sind. Beginnen Sie daher mit der Überprüfung, dass diese Informationen dort vorhanden sind.

Die Vorbereitungen sind abgeschlossen! Jetzt können wir die eigentliche CSS-Eigenschaftsseite hinzufügen. Der einfachste Weg, eine neue CSS-Eigenschaftsseite zu erstellen, besteht darin, den Inhalt einer vorhandenen CSS-Eigenschaftsseite zu kopieren und ihn für die neue Eigenschaft zu bearbeiten. Um eine neue Seite zu erstellen, sehen Sie sich die Anweisungen in unserer Anleitung zum Erstellen einer Seite an.

Wenn Sie eine Referenzseite erstellen, möchten Sie Beispiele hinzufügen. Um dies zu tun, folgen Sie diesem Tutorial über Live-Beispiele. Denken Sie daran, dass die von Ihnen erstellte Eigenschaftsseite für eine einzelne Eigenschaft gedacht ist. Daher müssen die Beispiele zeigen, wie diese Eigenschaft isoliert funktioniert, und nicht, wie die gesamte Spezifikation verwendet wird. Daher sollten Beispiele für die list-style-type-Eigenschaft die Ergebnisse mit verschiedenen Werten für die Eigenschaft zeigen und nicht, wie sie mit anderen Eigenschaften, Pseudoklassen oder Pseudoelementen kombiniert wird, um schöne Effekte zu erzeugen. Tutorials und Leitfäden können geschrieben werden, um mehr zu zeigen.

Nachdem Sie die Eigenschaftsseite erstellt haben, reichen Sie sie als Pull-Anfrage ein. Ein Mitglied unseres Überprüfungsteams wird automatisch zugewiesen, um Ihre Seite zu überprüfen.