執筆ガイドライン

MDN Web Docs はオープンソースのプロジェクトです。以下のセクションは、MDN Web Docs で私たちが「何を」文書化し、「どのよう」にそれを行うかについてのガイドラインを記述したものです。どのように協力するかについては、協力ガイドラインを参照してください。

私たちが書くものは何か

このコーナーでは MDN Web Docs に載せるものと載せないもの、そして新しい技術について書く場合、コンテンツの提案プロセス、外部リンクを受け入れるかどうかなど、他の多くのポリシーについて説明します。私たちのためにコンテンツを書いたり更新したりすることを検討しているのであれば、これは良い出発点です。このコーナーには、以下の記事も載せています。

掲載基準

MDN Web Docs に載せるべきコンテンツの詳細な基準、 MDN Web Docs で新しい文書化をしてもらうための申請プロセス、申請する側の希望やガイドラインを提供しています。

執筆スタイルガイド

執筆スタイルガイドは、 MDN Web Docs で使用する言語とスタイルを扱います。また、サンプルコードの書式化の方法も扱っています。

ウェブ開発の学習の執筆ガイドライン

MDN の「ウェブ開発の学習」の章は、ウェブ開発の基本を学んでいる人々を対象としており、そのため、 MDN の他のコンテンツとは異なる手法が要求されます。この記事では、学習コンテンツを執筆するためのガイドラインを提供しています。

MDN Web Docs への書き方

このコーナーでは、ページを作成・編集するためのすべての情報に加え、私たちが遵守している特定のプロセスやテクニックについて説明します。このコーナーでは、ページの作成を始めるための情報、このページの構成に関する一般的な概要、および特定の作業に関するハウツーを探すための場所を提供します。このコーナーでは、以下のようなトピックを載せています。

技術の調査方法

この節では、文書化する技術を調査するための便利なヒントを提供します。

ページの移動と削除の方法

この節では、MDN Web Docsでページを作成、移動、削除する方法について説明します。また、ページを移動したり削除したりするときのリダイレクト方法についても説明します。

Markdown の使用

私たちが使用している markdown 形式は GitHub flavored markdown (GFM) に由来しています。このコーナーは MDN Web Docs で使用する markdown のガイドであり、メモや 定義リストのような特定のページ内構成要素のための形式を含みます。

画像やメディアの追加

このコーナーでは、画像などのメディアをページに載せるための要件について記述します。

CSS プロパティの記事の作成方法

この記事では、レイアウトやコンテンツなど、 CSS プロパティページの書き方を解説します。

API リファレンスの書き方

この節では、 Web API の文書化の手法を説明します。

HTTP ヘッダーの記事の作成方法

この記事では、 HTTP ヘッダーの新しい参照ページを作成する方法を説明します。

用語集への項目の追加

この章では MDN Web Docs の用語集に項目を追加してリンクする方法について説明します。また、用語集の項目のレイアウトと内容に関するガイドラインを提供します。

MDN Web Docs のページ種別

MDN Web Docs の各ページには、CSS リファレンスページや JavaScript ガイドページなど、特定のページ の種類があります。この章では、異なるページの種類をリストアップし、それぞれの型に対応したテンプレートを提供します。これらを閲覧して、自分がどのページ種類を入力しているのか理解するのがよい考えです。

MDN Web Docs のページ構造について

この章では、MDN Web Docs で一貫した情報の表示を提供するために使用する、さまざまなページ構造について説明します。これには以下が含まれます。

構文の節

MDN Web Docs のリファレンスページの構文の節には、機能の正確な構文を定義する構文ボックスが格納されています。この記事では、参照する記事の構文ボックスの書き方を説明します。

サンプルコード

ページにサンプルコードを入れるには、さまざまな方法があります。この章では、それらの概要を説明し、異なる言語のための構文ガイドラインを提供します。

バナーと注意

時々、記事に特別な注意を追加する必要があります。これはページが非推奨の技術や運用コードで使用すべきではない他の素材に応じた場合に起こります。この記事では最も一般的なケースとその処理方法を述べます。

仕様書一覧表

MDN Web Docs のすべてのリファレンスページは、その API や技術が定義された詳細度や仕様に関する情報を提供する必要があります。この記事では、これらの表がどのように見えるかを示し、追加する方法を説明します。

互換性一覧表

MDN Web Docs では、開くための互換性表の標準形式を用意しています。この記事では、互換性表を生成するために使用するデータベースに追加し、管理する方法と、記事に表を統合する方法について説明します。

マクロ

マクロとは、ページ内でサイドバーなどのコンテンツを生成するために使用するショートカットのことです。この章では、使用するマクロとその機能を一覧で紹介します。

帰属表示と著作権使用許諾情報

このコーナーでは、著作権使用許諾コンテンツとは何か、正しく著作権表示する方法について記述します。

技術のラベル付け方法

この章では、廃止、非推奨、実験的という用語の定義と、MDN Web Docs からコンテンツを削除する場合のガイドラインを説明します。