文書の構造

MDN 全体を通して、MDN の記事で一貫した情報を表示するために繰り返し使用される様々な文書化構造があります。ここでは、MDN の執筆者として、あなたが書いたり、編集したり、翻訳したりする文書で、これらの構造を認識し、適用し、適切に変更できるように、これらの構造を説明した記事を紹介します。

クイックリンク

MDN はページへのクイックリンクの追加に対応しています。これらのボックスは、 MDN 上の他のページやサイト外のページへの階層的なリストを含むことができます。この記事では、クイックリンクボックスの生成方法を解説します。

コードサンプル

MDN では、ウェブプラットフォームの機能の使い方を示すために、ページ中に数多くのコードサンプルが挿入されています。この記事では、ページにコードサンプルを追加するためのさまざまな仕組みと、どのような場合にどのような仕組みを使うべきかについて説明します。

バナーと注意

時には、記事に特別な注意を加える必要があります。 これは、そのページが非推奨の技術や、本番コードで使うべきでない他の資料を扱っている場合に起こるかもしれません。 この記事では、最も一般的なそのようなケースと、何をすべきかを説明します。

ページの種類

MDN には繰り返し使用されるいくつかの種類のページがあります。 この記事では、これらのページの種類とその目的、および新しいページを作成するときに使用するそれぞれのテンプレートの例と使用方法について説明します。

マクロの使用

MDN が動作している Yari プラットフォームは、幅広い作業の自動化を可能にする強力なマクロシステムである KumaScript を提供しています。この記事は MDN のマクロを記事中で呼び出す方法について情報を提供します。

ライブサンプル

MDN は、記事に表示されるサンプルコードを、読者が実際に見ることができる実行サンプルにする機能に対応しています。これはライブサンプルと呼ばれ、ユーザーはコードの出力がどのようなものかを見ることができます。また、ドキュメントをよりダイナミックで有益なものにします。

互換性一覧表とブラウザー互換性データリポジトリー (BCD)

MDN には、DOM, HTML, CSS, JavaScript, SVG などの、あらゆるブラウザーで共有される技術についての互換性を表す一覧表の標準フォーマットがあります。 このデータを複数のプロジェクトで機械的に利用できるようにするため、Node.js パッケージが browser-compat-data リポジトリーからビルドされ、npm に公開されています。

仕様書一覧表

MDN 上のすべてのリファレンスページでは、 API または技術が定義されている仕様書に関する情報を提供するようにしてください。この記事ではこれらの表の外見を示し、構築方法を説明します。

構文の節

MDN リファレンスページの構文の節には、機能が持つ正確な構文を定義する構文ボックスがあります(例えば、どのような引数が受け入れられるか、どれがオプションかなど)。この記事では、リファレンス記事の構文ボックスの書き方を説明します。