MDC:Writer's guide
出典: MDC
- How to help: 目次
- (MDC各言語共通)
- 一覧
- Documentation wishlist
- 編集/レビューが必要な項目一覧
- 移設リスト
- ガイド
- はじめるには
- 記述者ガイド (英語版の訳)
- Writing interface reference documentation
- ページ命名ガイド
- あいまい性除去のページ
- MDCの新しいローカライズをはじめる
- 著作権とライセンス
- リファレンス
- Wiki マークアップリファレンス
- カスタム CSS クラス
- カスタムテンプレート
- MediaWiki 拡張
- 外部リダイレクト
- リダイレクトが必要なページ
- MDC日本語版
- 日本語版
- 翻訳
- 井戸端会議
- 通信
この記述者向けガイドは、Mozilla Developer Center の "独自スタイル" です。厳密なルールセットというよりも、むしろ使いやすいガイドラインを意図していますので、厳密にこれに従う必要はありません。ただ、もし熱心なボランティアがあとからやって来て、あなたの作業をこのガイドラインにより合わせる形に編集しても、驚いた混乱したりしないでください。
当然ながら、このガイドは主として英語版の MDC に適用されます。日本語版については、MDC:記述者ガイド のほうも参考にしてください。 なお、日本語版内で、英語表記を利用する場合 (ほとんどの場合は英語版の文章そのままだと思いますが) は、下記のガイドを参考にしてください。
目次 |
[編集] 好ましいスタイルガイド
もし、ここで述べられていない使い方やスタイルについての疑問があれば、まずは エコノミスト誌のスタイルガイド (英語) もしくは、そこになければ シカゴのスタイルマニュアル を参照してください。
[編集] 優先すべき辞書
スペルに関する質問は Answers.com での結果を参考にしてください。代替スペルは絶対に利用しないでください。(honor の代わりに honour を利用しないでください。)
このガイドをどんどん拡張していくつもりではありますが、このガイドに含まれない特定の事柄についての質問があれば、MDC メーリングリスト もしくは、プロジェクトリーダー まで何を追加すべきかを連絡してください。
[編集] ページ名と頭文字の大文字化
- ページ名と節の見出しには、見出しに利用されるスタイルでの大文字化 (すべての単語の先頭文字を大文字化する) ではなく、文単位での大文字化 (最初の単語と固有名詞の先頭のみを大文字化) を利用してください。
- 正: "A new method for creating JavaScript rollovers"
- 誤: "A New Method for Creating JavaScript Rollovers"
現在、ページ名についての大文字化ルールは新規ページにのみ適用されています。wiki 内には、かなりの数のこの規則に従わないページがありますが、現時点での修正は行わないでください。将来のどこかの時点で、それらの古くからあるページについて新しいページ名の決定を行います。よろしくお願いいたします。 -- dria 09:20, 14 March 2006 (PST)
[編集] ラテン略語
[編集] 注釈と括弧
- 一般的なラテン略語 (etc., i.e., e.g.) を挿入的な説明と注意書きの中で利用するでしょう。これらの略語ではピリオドを使ってください。
- 正: Web browsers (e.g. Firefox) can be used ...
- 誤: Web browsers e.g. Firefox can be used ...
- 誤: Web browsers, e.g. Firefox, can be used ...
- 誤: Web browsers, (eg: Firefox) can be used ...
[編集] 本文中
- 通常の文章中 (ノートや注釈でない文章) では、略語と同義の英語を使ってください。
- 正: ... web browsers, and so on.
- 誤: ... web browsers, etc.
- 正: Web browsers such as Firefox can be used ...
- 誤: Web browsers e.g. Firefox can be used ...
[編集] ラテン略語に対応するラテン表記と英語表現
| 略語 | ラテン語 | 英語 |
|---|---|---|
| cf. | confer | compare |
| e.g. | exempli gratia | for example |
| et al. | et alii | and others |
| etc. | et cetera | and so forth, and so on |
| i.e. | id est | that is, in other words |
| N.B. | nota bene | note well |
| P.S. | post scriptum | postscript |
注 : "e.g." と "i.e." の違いに注意してください。
[編集] 頭字語と略語
[編集] 大文字化とピリオド
- "US" や "UN" などといった組織名を含む頭字語と略語では、全体を大文字にしてピリオドを除いてください。
- 正: XUL
- 誤: X.U.L.; Xul
[編集] 略語の展開
- 文書ではじめに略語が出てくる際に、丸括弧囲みで説明を入れてください。
- 正: "XUL (XML User Interface Language) is Mozilla's XML-based language..."
- 誤: "XUL is Mozilla's XML-based language..."
[編集] 例外
- 利用者にとってなじみのないであろう頭字語のみについて展開してください。もし、なじみがあるかどうかわからない場合は、展開してください。
[編集] 頭字語や略語の複数形
- 頭字語や略語が複数の場合は、s を追加してください。
- 正: CD-ROMs
- 誤: CD-ROM's
[編集] 短縮形
- 短縮形 ("don't", "can't", "shouldn't" など) を利用するのは問題ありません。
[編集] 複数形
- 英語式の複数形を使い、ラテン語やギリシャ語での変形は使わないでください。
- 正: syllabuses, octopusses
- 誤: syllabi, octopi
[編集] ハイフン付け
- 接頭詞が母音で終わり、しかも続く語の先頭と同じ文字であるような複合語については、ハイフンを入れてください。
- 正: email, re-elect, co-op
- 誤: e-mail, reelect, coop
[編集] 数と数詞
日付の項目は変わるかもしれません。
[編集] 日付
- 日付は (コードサンプル中の日付は含まない) この書式を使います: January 1, 1990.
- 正: February 24, 2006
- 誤: February 24th, 2006; 24 February, 2006; 24/02/2006
- 代わりに、YYYY/MM/DD フォーマットを使うこともできます。
- 正: 2006/02/24
- 誤: 02/24/2006; 24/02/2006; 02/24/06
[編集] 10年 (decade)
- 10 年 (年代) はこの書式を使います: 1990s.
- 正: 1990s
- 誤: 1990's
[編集] 数詞の複数形
- 数詞の複数形には s を加えます。
- 正: 486s
- 誤: 486's
[編集] コンマ
- 本文では、コンマは 5 桁以上ある数字に使います。
- 正: 4000; 54,000
- 誤: 4,000; 54000
[編集] 句読点
[編集] シリアルコンマ
- シリアルコンマを作ってください。シリアル ("Oxford" としても知られる) コンマとは、3 つ以上連続した項目での“and" の前に挿入するコンマのことです。
- 正: I will travel on trains, planes, and automobiles.
- 誤: I will travel on trains, planes and automobiles.
[編集] つづり
- 変異つづりを持っている単語は、Answers.com の最初のエントリを常に使ってください。変異つづりは使わないでください。
- 正: localize, honor
- 誤: localise, honour
[編集] その他の資料
もし、文章作成や編集のスキルを向上させることに興味があるなら、以下の資料が参考になるでしょう。
- On Writing Well, by William Zinsser (Amazon link)
- Elements of Style, by Strunk and White
- American Heritage Book of English Usage
- Common Errors in English
- English Grammar FAQ (alt.usage.english)
- Bob's quick guide to the apostrophe, you idiots (funny)