How-to ガイド

MDN Web Docs 執筆ガイドラインのこのセクションでは、MDN Web Docs に協力する際に特定のタスクを達成するための手順を詳細に説明しています。マークダウンの使用方法、用語集に項目を追加する方法、ページの移動や削除方法などです。 協力の方法についての詳細は、協力ガイドラインをご覧ください。 以下の記事では、あなたが協力ガイドラインをすべて読み、mdn/content リポジトリーの使い方をよく理解し、git と GitHub の使用方法を知っていることを想定しています。

API リファレンスの書き方

このガイドでは、 MDN で API リファレンスを書くために必要なすべてのことを説明します。

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

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

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

MDN Web Docs の HTTP ヘッダーリファレンス は、 HTTP のヘッダーフィールドを説明しています。これらはハイパーテキスト転送プロトコル HTTP のリクエストおよびレスポンスメッセージのヘッダーセクションの構成要素です。ここでは HTTP トランザクションの操作引数を定義しています。この記事は、 HTTP ヘッダーに対応する新しいリファレンスページを作成する方法を説明します。

Markdown の書き方

このページでは、 Markdown を使用してどのように MDN Web Docs のドキュメントを書くかを説明します。ベースラインとして GitHub-Flavored Markdown (GFM) を選択し、 GFM では容易にサポートされていない MDN で行う必要のあるいくつかのことに対応するために、いくつかの拡張機能を追加しました。

ウェブのエラー記事の作成方法

MDN の JavaScript エラーリファレンス は 開発者コンソールで発生するエラーについて、ウェブ開発者を手助けすることを目的としたプロジェクトです。このプロジェクトでは、メッセージが発生するツールへのリンクを追加できるように、 MDN Web Docs でより多くのエラー文書を書く必要があります。この記事ではウェブエラーの文書化について説明します。

ページの作成、編集、移動、削除方法

この記事はページを作成、移動、削除、編集する方法を記述しています。 これらの場合、執筆ガイドラインを調べ、必要な措置があるかどうかを判断した上で、MDN Web Docs のコミュニケーションチャネルのいずれかを通じてチームと相談して進めることをよい考えとしてお勧めします。

技術の調査方法

訳注: MDN Web Docs では、日本語版の記事を最初から作成するのではなく、まず英語版の記事を作成してから日本語訳するようにしてください。

構造化データの使用方法

MDNは可能な限り、明確に定義された構造でデータを格納されます。この情報は一元化され、一度の更新で多くの場所で使用することができます。

用語集の項目を執筆する方法

訳注: MDN Web Docs では、日本語版の記事を最初から作成するのではなく、まず英語版の記事を作成してから日本語訳するようにしてください。

画像、メディア、資産の追加方法

このページでは、 MDN で文書内のページに画像やメディアを追加する方法について記述しています。