Руководство по стилю

From VRChat Wiki
Revision as of 20:55, 8 September 2024 by like3ds (talk | contribs) (Created page with "Инструкции по форматированию см. в разделе формат заголовка статьи, принимая во внимание следующее: * Начинайте с заглавной буквы, но в остальном следуйте регистру sentence case. VRChat использует регистр sentence case для предложений, названий статей, названий разделов, заг...")

Данное руководство по стилю (MoS или MOS) представляет собой рекомендуемое руководство по стилю для VRChat Wiki.

В общем:

  • Весь контент на Wiki VRChat должен быть правдивым и точным.
  • Авторы должны писать статьи, используя простой, лаконичный, понятный язык, и структурировать статьи с помощью единообразных, удобных для читателя макетов и форматирования.
  • Если у вас возникли вопросы по стилю, макету или форматированию VRChat Wiki, обратитесь за помощью к одному из модераторов сообщества.

Ниже подробно изложены несколько конкретных рекомендаций по стилю:

Названия статей

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

Инструкции по форматированию см. в разделе формат заголовка статьи, принимая во внимание следующее:

  • Начинайте с заглавной буквы, но в остальном следуйте регистру sentence case. VRChat использует регистр sentence case для предложений, названий статей, названий разделов, заголовков таблиц, подписей к изображениям, записей в списках (в большинстве случаев), а также записей в информационных полях и подобных шаблонах, среди прочего.
  • Не используйте артикли (a, an или the) в качестве первого слова (VRChat Creator Economy, а не The VRChat Creator Economy), если только они не являются неотъемлемой частью названия (The Black Cat) или заголовка произведения (The VRChat Times).
  • Используйте существительные или словосочетания с существительными: Early life, а не In early life. Такие фразы, как In early life, приемлемы (хотя и не обязательны) в качестве заголовков разделов. Они также часто используются как часть длинных заголовков статей, таких как VRChat Events, особенно когда более короткая конструкция (Events) может иметь проблемы с двусмысленностью.
  • Последний символ не должен быть знаком препинания, если только он не является неотъемлемой частью названия (например, Do Androids Dream of Electric Sheep?), или аббревиатурой (VRChat Inc.), или когда требуется закрывающая круглая скобка или кавычка (Fantastic Avatars (and where to find them)).
  • Всякий раз, когда появляются кавычки или апострофы, добавляйте перенаправление для того же заголовка, используя апострофы. Избегайте использования фигурных кавычек, поскольку прямые кавычки и апострофы проще вводить и они надежнее отображаются на большинстве платформ.

Section headings

Section headings should generally follow the guidance for article titles (above), and should be presented in sentence case (How to feed your VRCat), not title case (How To Feed Your VRCat).

The heading must be on its own line, with one blank line just before it; a blank line just after is optional and ignored (but do not use two blank lines, before or after, because that will add unwanted visible space).

For technical reasons, section headings should:

  • Be unique within a page, so that section links lead to the right place.
  • Not contain links, especially where only part of a heading is linked.
  • Not contain images, emoji or icons.
  • Not contain citations or footnotes.
  • Not misuse description list markup (";") to create pseudo-headings.
  • Not contain template transclusions.

As a matter of consistent style, section headings should:

  • Not redundantly refer back to the subject of the article, e.g., Early life, not Smith's early life or His early life.
  • Not refer to a higher-level heading, unless doing so is shorter or clearer.
  • Not be numbered or lettered as an outline.
  • Not be phrased as a question, e.g., Languages, not What languages are spoken in Mexico?.
  • Not use color or unusual fonts that might cause accessibility problems.
  • Not be wrapped in markup, which may break their display and cause other accessibility issues

English word choice and capitalization

In order to make localization of the wiki content easier in the long run, consider a few style choices such as these:

  • Quotations, titles of works (books, films, etc.) should be capitalized as given in the source (but see Typographic conformity, below);
  • Proper names use the subject's own spelling and capitalization, e.g., "...joint project of VRChat Inc. and VRChat Community Labs..."; "International Avatar Federation"
  • Generally, do not capitalize the word the in mid-sentence: throughout the United Kingdom, not throughout The United Kingdom.
  • Use universally accepted terms rather than those less widely distributed, especially in titles. For example, "glasses" is preferred to the national varieties spectacles (British English) and eyeglasses (American English); "Ten million" is preferable to "one crore" (Indian English).
  • If a variant spelling appears in a title, make a redirect page to accommodate the others, as with "artefact" and "artifact", so that all variants can be used in searches and linking.
  • Use a commonly understood word or phrase in preference to one that has a different meaning because of national differences (rather than "alternate", use "alternative" or "alternating", as appropriate), except in technical contexts where such substitution would be inappropriate ("alternate reality"; "alternate universe").