Anleitung zur Dokumentation einer CSS-Eigenschaft

Zuerst müssen Sie herausfinden, welche CSS-Eigenschaft Sie dokumentieren möchten. Sie haben vielleicht bemerkt, dass eine Seite fehlt, oder fehlende Inhalte in unserer Problemliste gemeldet gesehen. Für Details ü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).

Wenn die Implementierung und Spezifikation auseinanderdriften, erwähnen Sie es gerne im Implementierungsfehler. Eine der folgenden Situationen ist möglich:

• Es könnte ein Fehler in der Implementierung sein (und ein Folgefehler wird gemeldet).
• Es könnte an einer Verzögerung bei der Veröffentlichung einer neuen Spezifikation liegen.
• Es könnte ein Fehler in der Spezifikation sein (falls ja, lohnt es sich, einen Spezifikationsfehler zu melden).

Mehrere Merkmale einer CSS-Eigenschaft, wie z.B. ihre Syntax oder ob sie animiert werden kann, werden auf mehreren Seiten erwähnt und sind daher in einer Ad-hoc-Datenbank gespeichert. Makros, die Sie auf der Seite verwenden werden, benötigen Informationen über die Eigenschaft, die dort gespeichert sind, also beginnen Sie damit, zu überprüfen, ob diese Informationen vorhanden sind.

Vorbereitungen abgeschlossen! Jetzt können wir die eigentliche CSS-Eigenschaftsseite hinzufügen. Der einfachste Weg, eine neue CSS-Eigenschaftsseite zu erstellen, ist das Kopieren des Inhalts einer bestehenden CSS-Eigenschaftsseite und deren Bearbeitung für die neue Eigenschaft. Um eine neue Seite zu erstellen, folgen Sie den Anweisungen in unserer Anleitung zur Seitenerstellung.

Wenn Sie eine Referenzseite erstellen, möchten Sie Beispiele hinzufügen. Dazu folgen Sie diesem Tutorial über Live-Beispiele. Denken Sie daran, dass die Eigenschaftsseite, die Sie erstellen, für eine einzelne Eigenschaft gedacht ist, sodass die hinzugefügten Beispiele zeigen müssen, wie diese Eigenschaft isoliert funktioniert, nicht wie die gesamte Spezifikation verwendet wird. Daher sollten Beispiele für die Eigenschaft list-style-type die Ergebnisse bei Verwendung unterschiedlicher Werte für die Eigenschaft zeigen, 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 diese als Pull-Request ein. Ein Mitglied unseres Überprüfungsteams wird automatisch zugewiesen, um Ihre Seite zu überprüfen.