ガイドライン

これらのガイドは MDN の文書がどのように書かれ、整形されるべきかの詳細を説明します。同様に、コードのサンプル、その他の素材をどのように示したら良いかについても説明します。 これらのガイドに従うならば、あなたの成果物はきれいなものであり、すぐに使えるものとなります。

Code example guidelines

This document series outlines the coding guidelines and best practices we use for writing demos, code snippets, interactive examples, etc, for use on MDN.

MDN Web Docs に掲載するものであるかどうか

この記事では、ある主題やコンテンツの種類を MDN Web Docs に載せるべきかどうかを決定する方法について説明します。

MDN の動画コンテンツ

MDN Web Docs は動画が多いサイトではありませんが、動画コンテンツを記事の一部として使用することに意味がある場所がいくつかあります。この記事では、 MDN の記事に動画を含めることが適切な場合について説明し、シンプルだが効果的な動画を予算内で作成するためのヒントを提供します。

MDN の慣習と定義

この記事では MDN で使用されている慣習や定義、特に文書化する際に人によっては忘れがちなものを紹介します。

執筆スタイルガイド

整理され、標準化され、読みやすい書き方でドキュメントを示すために、 MDN Web Docs スタイルガイドはテキストがどのような体系、表記、書式などに従うべきかを説明します。 これらは厳密な規則というのではなくガイドラインです。 形式よりも内容が重要であり、このため協力する前にガイドラインを学ばなければならないと重荷に感じたりしないでください。 とはいえ、真面目な他のボランティアが、あとであなたの成果をガイドラインに添うように書き換えても、びくびくしたり、ぎょっとしたりもしないでください。

編集方針

この記事では、Mozilla MDN のスタッフが MDN Web ドキュメントのコンテンツを管理するために設定したポリシーについて説明します。