Skip to main content

Visit Mozilla.org

MDC:Writer's guide

Материал из MDC.

Шаблон:MDCProjectPagesTOC

Это руководство авторам - начало Центра Разработки Мозиллы (MDC). Оно предназначено, чтобы быть дружественным набором руководящих принципов, а не строгого набора правил, так что вы можете проигнорировать что-либо. Не расстраивайтесь и не удивляйтесь, если трудолюбивый доброволец позже прийдёт и подправит вашу работу, чтобы больше соответствовать этим правилам.

Естественно, это руководство применимо в основном к английской Вики. Для других языков Вики можно создавать (и мы это приветствуем) свои руководства.

Содержание

[править] Руководства по предпочтительному стилю

Если у вас есть какие-нибудь вопросы по стилю или политике использования, не обнаруженные здесь, рекомендую обратиться к Economist style guide или, на крайний случай, к Chicago Manual of Style.

[править] Предпочитаемый словарь

По вопросам правописания, пожалуйста обращайтесь к Яндекс.Словари пожалуйста, не коверкайте слова, и старайтесь использовать технические термины вместо сленга.

Руководство постоянно пополняется, так что если у вас есть необычные вопросы, которые не поясняются в этом документее, пожалуйста, присылайте их нам в список рассылки MDC или руководителю разработчиков документации, что бы занть, что требуется добавить.

[править] Использование заглавных букв в названиях Страниц и Заголовков

Название страниц и заголовки разделов должны использовать заглавные буквы как в предложении (заглавная буква только в первом слове предложения и в любых именах собственных):

    • Правильно: "Новый метод for creating JavaScript rollovers"
    • Неправильно: "A New Method for Creating JavaScript Rollovers"
For the time being, these capitalization rules for page names apply only to new pages. Although a large number of pages in our wiki don't conform to these rules, please don't correct those at this time. We will sort out the logistics and fix older page names at some point in the future. Thanks. -- dria 09:20, 14 March 2006 (PST)

[править] Latin abbreviations

[править] In notes and parentheses

  • Common Latin abbreviations (etc., i.e., e.g.) may be used in parenthetical expressions and in notes. Use periods in these abbreviations.
    • Correct: Web browsers (e.g. Firefox) can be used ...
    • Incorrect: Web browsers e.g. Firefox can be used ...
    • Incorrect: Web browsers, e.g. Firefox, can be used ...
    • Incorrect: Web browsers, (eg: Firefox) can be used ...

[править] In running text

  • In regular text (i.e. text outside of notes or parentheses), use the English equivalent of the abbreviation.
    • Correct: ... web browsers, and so on.
    • Incorrect: ... web browsers, etc.
    • Correct: Web browsers such as Firefox can be used ...
    • Incorrect: Web browsers e.g. Firefox can be used ...

[править] Meanings and English equivalents of Latin abbreviations

Abbrev Latin English
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

N.B. Be careful not to confuse "e.g." with "i.e."

[править] Acronyms and abbreviations

[править] Capitalization and periods

  • Use full capitals for and delete periods in all acronyms and abbreviations, including organizations such as "US" and "UN".
    • Correct: XUL
    • Incorrect: X.U.L.; Xul

[править] Expansion

  • On the first mention of a term on a page, introduce its expansion in parentheses.
    • Correct: "XUL (XML User Interface Language) is Mozilla's XML-based language..."
    • Incorrect: "XUL is Mozilla's XML-based language..."

[править] Exceptions

  • Expand only those acronyms likely to be unfamiliar to users. When in doubt, expand it.

[править] Plurals of acronyms and abbreviations

  • For plurals of acronyms or abbreviations, add s.
    • Correct: CD-ROMs
    • Incorrect: CD-ROM's

[править] Contractions

  • You are welcome to use contractions (e.g. "don't", "can't", "shouldn't") if you prefer.

[править] Pluralization

  • Use English-style plurals, not the Latin- or Greek-influenced forms.
    • Correct: syllabuses,
    • Incorrect: syllabi, octopi

[править] Hyphenation

  • Hyphenate compounds in which the last letter of a prefix ending in a vowel is the same as the first letter of the root.
    • Correct: email, re-elect, co-op
    • Incorrect: e-mail, reelect, coop

[править] Numbers and numerals

The date stuff here may change.

[править] Dates

  • For dates (not including dates in code samples) use the format: January 1, 1990.
    • Correct: February 24, 2006
    • Incorrect: February 24th, 2006; 24 February, 2006; 24/02/2006
  • Alternately, you can use the YYYY/MM/DD format.
    • Correct: 2006/02/24
    • Incorrect: 02/24/2006; 24/02/2006; 02/24/06

[править] Decades

  • For decades, use the format: 1990s.
    • Correct: 1990s
    • Incorrect: 1990's

[править] Plurals of numerals

  • For plurals of numerals add s.
    • Correct: 486s
    • Incorrect: 486's

[править] Commas

  • In running text, use commas only in five-digit and larger numbers.
    • Correct: 4000; 54,000
    • Incorrect: 4,000; 54000

[править] Punctuation

[править] Serial comma

  • Use the serial comma. The serial (also known as "Oxford") comma is the comma that appears before "and" in a series of three or more items.
    • Correct: I will travel on trains, planes, and automobiles.
    • Incorrect: I will travel on trains, planes and automobiles.

[править] Spelling

  • For words with variant spellings, always use the first entry at Answers.com. Do not use variant spellings.
    • Correct: localize, honor
    • Incorrect: localise, honour

[править] Other resources

If you're interested in improving your writing and editing skills, you may find the following resources to be helpful.

Получено с http://developer.mozilla.org/ru/docs/MDC:Writer%27s_guide