この翻訳は不完全です。英語から この記事を翻訳 してください。
何らかの文書をまとめる準備をしている場合、その情報をMDNに置くかどうか決めたりするかもしれません。加えて、ソースコード内の文書を維持したり、 その文書をMozilla wikiや、git リポジトリ内のreadmeファイルに置いたりすることを検討しているかもしれません。この記事の目的は、あなたのコンテンツにとって、これらのオプションのどれが正しいのかを決めるのに役立つ事です。
文書をMDNに入れるかどうかについて、主に2つ考慮する点があります:
- 文書のトピック (何についてのものか?)
- 文書の性質 (これはどんな種類の文書か?)
Note: Keep in mind that Mozilla's Websites & Communications Terms of Use are in effect when you use or contribute to MDN. Review this document to ensure that you're aware of what can and cannot be posted on Mozilla sites.
MDNに含まれるトピックは?
MDNでは驚くほど色々な種類の中身をカバーしています。つまり、一般に、オープンなWebが直面するテクノロジーや、Mozilla製品である場合、これをMDNにて文書化します。しかし、少しの直接的なものはMDNに含まれないこともあります。この節では、MDNをあなたの文書化のホームとするのに適しているかを理解するのに役立ちます。
これは、我々がカバーしている一部を味見したものです。つまり完全なリストではありませんが、あなたに見解をもたらすでしょう。
オープンな Web 標準とテクノロジー
我々の Web標準の文書化についての現在の重点は、今日の幅広い顧客のためにサイトやアプリを作っているWeb開発者によって使用される機能です。これはつまり、複数ブラウザで実装され、標準として受け入れられるものや、標準化に向けて前進しているものです。第一の重点箇所は、フロントエンドwebテクノロジーです。バックエンドテクノロジーには、別の文書化の場所があり、MDNはこれにとって変わるつもりはありません。
テクノロジーを横断しているが、Web開発に関係するトピックも歓迎されます、例えばこちら:
Note: MDN covers even non-Mozilla technologies if they're exposed to the Web; for example, we have documentation for WebKit-specific CSS properties.
Mozilla 製品
このカテゴリの文書には、Mozilla製品に対して開発者として作業する方法と、これらのオープンソースプロジェクトに貢献する方法との、両方があります。
MDNに含まれないトピックは?
MDN用のトピックとしてふさわしくない例は次の通り:
- Webに公開されていないテクノロジーだが、Mozilla以外のブラウザに固有のもの
- WebにもMozilla製品にも関係しないテクノロジー
- エンドユーザ向けドキュメント。つまりMozilla 製品では、こうした文書はMozilla support siteに入っています。
MDNに含まれる文書の種類は?
通常、MDNはプロダクトのドキュメントであり、プロジェクトやプロセスのドキュメントではありません( about MDN itself より引用)。そのため、もしドキュメントが"どのように使うか"や"どのように動作するか"("どの"とは下記で記述されている特定のカテゴリのことです)ならMDNを参照しましょう。しかし、"誰が開発したか"や"開発プランについて"などはMDNにふさわしくありません。Mozilla傘下で開発されているものの場合はMozilla project wiki を参照するとよいでしょう。
これらがMDNとしてふさわしくないタイプのドキュメントの例です。
- Planning documents
- Design documents
- Project proposals
- Specifications or standards
- Promotional material, advertising, or personal information[*]
MDNに文書化するメリット
もしあなたがあなたが書きたいドキュメントがMDNのコンテンツとして適切かどうかを決定したい場合、また、そのドキュメントを投稿するのにMDNが一番良い場所かどうかを確信していない場合、この記事を読みましょう。ここにはたくさんのMDNにドキュメントを作成するためのメリットが載っています。
たくさんのライターと翻訳者
The MDN community is big. Really big. It's big in the sort of way that makes big things look small. Seriously, we have a lot of people that participate in creating and maintaining content on MDN. With writers and editors on every continent (okay, I'm not sure about Antarctica, but otherwise), there's a lot of value to the sheer volume of writers:
- We have a paid staff of writers whose mission is to make sure that our content is as good as possible.
- We have a core community of volunteers who contribute substantial amounts of content and can help you.
- The MDN team can work with you to ensure that your documentation project is adequately staffed.
- The broader MDN community also contributes enormously; from typo fixes to editorial reviews of your content, they can save your bacon.
- The #mdn channel offers a resource where you can talk to our writing community and get their advice, or recruit help with the production of or maintenance of your content.
- Because we have contributors all over the world, there's always someone around, watching for problems and fixing them.
- Our community of volunteers includes translators for many languages, who can help localize your documentation.
Do you want your development team to be entirely responsible for the production of documentation? That's likely if your documentation is maintained elsewhere.
維持
Because of the sheer number of contributors, there's usually someone on hand to watch for problems with your content: from spam control to copy-editing, things can happen around the clock. Here's just a taste of what our team can do:
- Delete spam
- Spam happens. We deal with it.
- Copy editing
- You don't have to worry if your writing isn't as clear or precise as you'd like. We'll turn your prose into something other people can read.
- Consistency of style
- We'll ensure that your content is stylistically consistent not just within itself, but with the other documentation around it.
- Content management
- Our team will help ensure that the documentation is cross-linked with other relevant materials, that articles are put in the right places, and that menus and other infrastructure is built to make it easy to follow and understand.
- Site and platform maintenance
- MDN has both an IT team who keep the site up, running, and secure, and a platform development team who maintain and enhance the platform. You won't need to devote your own or additional resources to documentation infrastructure.
他の場所に文書化する場合
There are also a few reasons you may be thinking about documenting your work somewhere other than MDN. Here are some of those reasons, and the pros and cons for each.
計画と手順
Documentation for plans, processes, and proposals should never be put on MDN. That's pretty simple. If your project is part of Mozilla, you can put them on the Mozilla project wiki.
Github上のプロジェクト
Some of Mozilla's projects are hosted on Github, and Github offers its own wiki-like system for documentation. Some teams like to produce their documentation there. This is certainly fair and convenient if you're game to write your own docs; however, keep in mind that:
- The MDN docs team will probably not be able to help you. We don't generally participate in documentation work off MDN; there are exceptions but they are rare.
- Cross-linking your documentation with other relevant materials may be difficult or impossible.
- The content will not have consistent style with other documentation.
- Your documentation loses discoverability by not being among other (Web or Mozilla) documentation.
- Github-hosted docs are generally not as attractive and/or readable as those hosted on MDN.
It's possible, of course, that these things don't bother you, or aren't a problem in your situation. Some teams don't mind keeping their own docs, or are working on code that has minimal documentation needs.
ソース内に文書を置きたい場合
Some teams like to have their documentation in the source tree. This is particularly common with project internals and library projects.
This approach has a couple of advantages:
- It lets the developers document their technology as they code it, helping to ensure that the docs stay up to date with the code.
- Docs can be subject to the same development and release processes as the code, including versioning.
There are some drawbacks:
- The MDN docs team can't help you; even if the code is within Mozilla's source repository, the system of reviews and check-ins make it impractical for the docs team to participate.
- You don't have easy tools for cross-linking with other relevant documentation. Cross-linking provides both context and additional important information to your readers.
- Your documentation loses discoverability by not being among other documentation.
- Even if you use conversion tools (like JavaDoc) to create Web-readable documentation, it won't be as attractive as what we can do on MDN.
Still, this can be a viable option (possibly even a good option) for some types of projects, especially small ones or those that aren't expected to get much interest.
^ It's OK to put a limited amount of personal information on your MDN profile page. User profiles should reflect a human being, not a business or organization. A moderate degree of self-promotion is OK, but link-spamming is not. Please do not use your profile to upload personal photos or other irrelevant files.