CSS プロパティの記事を作成するには

CSS 標準が進化するにつれて、新しいプロパティが常に追加されています。MDN の CSS リファレンスは、これらの開発に合わせて最新の状態に維持する必要があります。この文書では、CSS プロパティのリファレンスページを作成するためのステップごとの手順を説明します。

それぞれの CSS プロパティのリファレンスページは、同じ構造になっています。これによって、読者が標準的なリファレンスページの書式に慣れていれば、特に情報を見つけやすくなります。

手順 1 — 文書化するプロパティを決定する

まず、どのプロパティを文書化するかを決定する必要があります。ページが欠けていることに気づいたり、問題リストで報告されているコンテンツの欠落を見たことがあるかもしれません。 CSS プロパティの詳細については、その関連する仕様(たとえば W3C 仕様 や、Gecko や Blink などのレンダリングエンジンで使われている非標準のプロパティに関するバグレポート)を見つける必要があります。

Note: W3C の仕様を使うときは、公開版(例: Working Draft)ではなく、常 Editor's Draft (左側の赤いバナーに注目してください)を使ってください。 Editor's Draft は常に最終版に近いのです。

実装と仕様が乖離している場合、遠慮なく実装のバグに言及してください。実装のバグ(そしてフォローアップのバグが提出されます)、新しい仕様の発行の遅れ、仕様の誤り(この場合、仕様のバグを提出する価値があります)である場合があります。

手順 2 — CSS プロパティのデータベースを確認する

CSS プロパティのいくつかの特徴、例えばその構文やアニメーションが可能かどうかなどは、いくつかのページで言及されているため、アドホックデータベースに格納されています。ページで使用するマクロは、そこに保存されているプロパティに関する情報を必要とするので、まずこの情報があるかどうか確認することから始めてください。

手順 3 — CSS プロパティページの作成

準備完了です。では、実際に CSS プロパティページを追加してみましょう。新しい CSS プロパティページを作成する最も簡単な方法は、既存のページの内容をコピーして、新しいプロパティに合うように編集することです。新しいページを追加する方法は、 GitHub の README に記載されています。

リファレンスページを作成する際、を追加したいと思うでしょう。そのためには、このライブサンプルについてのチュートリアルに従ってください。私たちは 1 つのプロパティを説明する文書にいることを忘れないでください。仕様全体がどのように使用されるかではなく、このプロパティが単独でどのように動作するかを示す例を追加する必要があります。つまり、list-style-type の例では、様々なプロパティ値が何を生成するかを示すべきで、他のプロパティ、擬似クラス、擬似要素と組み合わせて、どのように素晴らしい効果を生成するかを示すべきではありません。より多くのことを示すには、チュートリアルやガイドで書いてください。

手順 4 — レビューを受ける

ページ作成後、プルリクエストとして提出すると、当社の審査担当者が自動的に割り当てられ、ページをレビューします。