User:FanCyy/Styleguide

Эта статья — руководство по редактированию Team Fortress Wiki. Она была создана, так как у каждого может быть свое мнение о том, что и как надо писать на TF Wiki.

Это руководство должно помочь всем придерживаться единого стиля и форматирования статей TF Wiki. Раскрыть в нем все возможные темы заняло бы слишком много времени, поэтому данная статья описывает только ситуации, характерные для TF Wiki. Чтобы ознакомиться с полным руководством по редактированию, обратитесь к статье «Оформление статей» русскоязычной Википедии.

Перевод статей

Основным языком TF Wiki является английский. Любая статья должна быть написана в первую очередь на английском языке, и только затем может быть переведена на все остальные; это же касается внесения любой информации в уже существующие статьи.

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

Все переводы внутриигровой информации выполняются на Steam Translation Server. До появления официального перевода во всех статьях необходимо использовать английское название объекта; любые правки с переводами названий, сделанные до официальных, будут отменены.

Заголовки

Заголовки должны быть короткими, простыми и емкими. Главное правило состоит в том, чтобы писать первое слово с прописной буквы, а последующие — со строчной. При этом в некоторых случаях написание слов с прописной может быть оправдано иными причинами (см. раздел Особые случаи). В заголовках стоит избегать использования эпитетов «правильный», «надежный» или аналогичных, а также символов транскрипции. Как правило, каждая статья описывает что-то одно, поэтому в заголовке не нужно отражать все перечисленные в ней темы.

Примеры хороших заголовков:

• Реплики инженера
• Прыжки на ракетах
• Контрольная точка
• Оружие ближнего боя

Примеры плохих заголовков:

• Солдат: руководство по прыжкам на ракетах
• СМЕРТЬ СПАЙКРАБАМ!!!
• Лучший Способ Убить Снайпера, А Потом Захватить Точку
• Как правильно уничтожить турель (Примечание: в данном случае понятие «правильно» субъективно и избыточно)
• Почему Разведчик является худшим классом
• Список крутых серверов

Введения

В рамках TF Wiki введение — это часть статьи до заголовка первого подраздела. Если в статье есть содержание, то оно отображается под введением и над первым подразделом.

Введение представляет собой краткое описание статьи и перечисление ее ключевых особенностей. Оно может содержать до четырех абзацев и должно быть написано простым и доступным языком. Введение служит «приглашением» к прочтению полной статьи.

Описываемый в статье предмет должен быть упомянут в самом начале первого предложения и выделен жирным начертанием, например:

Ракетомет — это стандартное основное оружие солдата.

Общие правила написания статей

Статьи по возможности должны быть написаны от третьего лица. Несмотря на то, что в рамках TF Wiki нейтральная точка зрения не является обязательной, следует избегать субъективных высказываний, например, вместо «мне нравится прятаться за ящиками, потому что так я лучше защищен» можно написать «приседание за ящиками позволяет быть лучше защищенным».

Такие возможности разметки, как жирное и курсивное начертание и ссылки облегчают чтение статей (см. Википедия:Шпаргалка для подробной информации). Для акцентирования внимания на слове стоит использовать курсивное начертание, а не жирное или ПРОПИСНЫЕ БУКВЫ. Жирное начертание применяется только для определений, заголовков таблиц и выделения имен (при этом каждое имя достаточно выделить один раз в рамках одной статьи). Также следует избегать двойного акцентирования внимания, однако в некоторых случаях полужирный курсив может использоваться для наиболее важных предупреждений. Кроме этого, при помощи курсивного начертания и кавычек в тексте выделяются имена и названия: например, названия игр набираются курсивом.

Избегайте использования:

• ТОЛЬКО ПРОПИСНЫХ БУКВ.
• Сокращений, принятых в чатах: R U OK?
• Смайликов: :)
• Избыточной пунктуации: !!!
• Предложений, начинающихся со строчной буквы: «в первую очередь ставим турель в углу».

Недостаточное и чрезмерное использование ссылок

Для более подробного руководства по использованию ссылок, пожалуйста, обратитесь к разделу «Ссылки, URL» статьи «Как править статьи» русскоязычной Википедии.

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

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

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

Общие правила использования ссылок:

• Ссылками должны быть не более 10% от использованных в статье слов.

• По возможности стоит избегать использования ссылок в стоящих рядом словах, поскольку они выглядят как одна общая ссылка; пример: маскировка шпиона.

• Не нужно размещать несколько одинаковых ссылок в одной статье: повторение ухудшает восприятие текста. Помните, что главным назначением ссылок является возможность перейти в другое место в случае, если читателю может понадобиться дополнительная информация.

• Несмотря на предыдущий пункт, повторение ссылок на ключевые термины в разных частях статьи может быть полезным: если какое-либо понятие упоминается несколько раз в большой статье, но ссылка на него дается только один раз в самом начале, статья становится неудобна для чтения. Безусловно, читатель тоже может вернуться к этой одиночной ссылке, но об этом стоит позаботиться заранее. Однозначного правила, на каком расстоянии стоит располагать повторяющиеся ссылки, не существует, но в спорных случаях лучше размещать их на некотором удалении друг от друга.

Правописание

При написании и редактировании статей на английском языке

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

По возможности стоит избегать неоднозначного прочтения текста, используя наиболее общеупотребительные слова: например, вместо «analyze the situation» можно написать «examine the situation».

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

Любой текст должен быть написан правильно. Используйте функцию предпросмотра, чтобы проверить внесенные изменения и исправить ошибки до сохранения страницы. Если английский язык не является для вас родным или вы сомневаетесь в правильности формулировки, может быть полезно написать об этом на странице обсуждения, чтобы другие пользователи могли вас поправить. Это существенно упрощает редактирование статей.

При переводе и редактировании статей на русском языке

Указанные выше правила применимы с некоторыми оговорками и к русскоязычному тексту, однако между пунктуацией в русском и английском языке есть несколько различий, на которые следует обращать внимание при переводах статей:

• В русском языке нужно использовать «французские» и „немецкие“ кавычки. "Двойных машинописных" кавычек следует избегать везде, где это возможно.
• В английском языке точка или запятая ставится перед закрывающей кавычкой, в русском — после. Пример:

“I joined this team just to kill maggots like you.” (English)

«Я в этой команде, чтобы убивать таких дурней, как вы». (русский)

• В английском языке в качестве десятичного разделителя используется точка, в русском — запятая. Пример:

0.625 (English)

0,625 (русский)

• После подписи (у эпиграфа или иллюстрации, в том числе в галерее) точка не ставится.

Также нужно обращать внимание на букву Ё:

• Общее правило: Ё используется везде, где она должна присутствовать в соответствии с правилами русского языка.
  • Исключением являются случаи, когда в официальном переводе названия или описания используется «Е». Пример: Билетер, Черный фолкеркский шлем.

Особые случаи

Team Fortress Wiki

Ссылаясь на Team Fortress Wiki в статьях, следует придерживаться двух вариантов:

Краткий вариант: TF Wiki (не TFWiki) или просто Wiki.

Полный вариант: Team Fortress Wiki.

Классы, предметы и термины

При написании и редактировании статей на английском языке

В общем случае названия классов должны быть написаны с прописной буквы: Engineer, Spy и т.д. Обычно в английском языке имена существительные пишутся со строчной буквы («engineer», «spy»), но в контексте Team Fortress 2 данные слова являются именами собственными и должны писаться с прописной.

Прочие слова и аббревиатуры, которые могут быть использованы в игре в качестве имени собственного, также пишутся с прописной, за исключением тех случаев, когда слово выступает в качестве имени нарицательного (см. пример с «Health» ниже). Это правило распространяется на названия оружия и аксессуаров, а также используемые в игре термины (см. категорию Glossary). При этом если название предмета состоит из более чем одного слова, второе и последующие также пишутся с прописной буквы.

Старайтесь избегать использования необязательных определенных артиклей. Например, не нужно создавать статьи с названиями «The Hound Dog», «The Gentle Manne's Service Medal», «The Pain Train» и т.д., вместо этого используйте в качестве заголовка просто «Hound Dog», «Gentle Manne's Service Medal», «Pain Train» и т.д.

Примеры:

• Правильно: Sentry Gun, неправильно: Sentry gun (также «Sentries» вместо «sentries»).
• Правильно: Butterfly Knife, неправильно: Butterfly knife.
• Правильно: Critical hit, неправильно: Critical Hit (также «Crit» вместо «crit»).
• Правильно: Health, неправильно: health, если речь идет об аптечках. Но при этом — «health» в качестве имени нарицательного (например, «player's health»).

Общим понятием для количества доступных боеприпасов любого оружия будет слово «clip», даже если с точки зрения «здравого смысла» этот термин неуместен (например, когда речь идет о ракетомете или гранатомете). Это также относится к боеприпасам турелей.

При переводе и редактировании статей на русском языке

В отличие от статей на английском языке, названия классов в большинстве случаев пишутся со строчной буквы: инженер, шпион и т.д. Исключением являются статьи о видео из серии «Знакомьтесь, Команда»: в них названия классов считаются именами персонажей и пишутся с прописной.

Со строчной буквы также пишутся все названия стандартного оружия, построек инженера и используемые в игре термины (см. категорию Glossary).

Названия оружия всех прочих категорий (разблокируемое, создаваемое при ковке, рекламное и т.д.), любых аксессуаров и инструментов, а также команд и режимов игры пишутся с прописной буквы. Если название состоит из нескольких слов, то в большинстве случаев с прописной пишется только первое из них, все остальные — со строчной, если не являются именами собственными.

Примеры:

• «Стандартным основным оружием солдата является ракетомет, разблокируемым — Прямое попадание».
• «Одним из первых аксессуаров, добавленных в игру, стала Солдатская каска».
• «В режиме Сопровождения для инженера Синих важно вовремя переносить выход телепорта, чтобы команда могла постоянно находиться рядом с вагонеткой».

Каламбуры и идиомы в названиях предметов

Зачастую оригинальное название или описание предмета представляет собой каламбур или устоявшийся оборот речи. Как правило, это будет отражено в разделе «Факты» (англ. Trivia) англоязычной статьи в виде короткого пояснения. При переводе статьи данный раздел должен быть сохранен, а при необходимости — дополнен.

В случае, если официальный перевод названия или описания сохраняет идиому или использует выражение, максимально приближенное по смыслу к оригиналу (например, Чёрный ящик, Полевая практика), дополнительно акцентировать на этом внимание не требуется.

Если в официальном переводе каламбур или идиома были проигнорированы (например, Быстроправ, Пушка без лафета), в соответствующем разделе следует упомянуть оригинальное название или описание предмета на английском языке и дать пояснение.

И, наконец, если официальный перевод обыгрывает другой оборот речи или представляет собой самостоятельную отсылку (например, Слонобой, Подкидыш, Вооружен и украшен), при переводе статьи стоит не только указать оригинальное название предмета в разделе «Факты», но и дополнить раздел пояснением к переведенному названию.

Обновления

Добавляя информацию о недавно внесенных изменениях, не нужно указывать, когда и в каком обновлении это было сделано, вместо этого сразу пишите так, словно описываемая ситуация существовала всегда (исключение — случаи, в которых информация о прежнем положении вещей может быть полезна). Это нужно для того, чтобы избежать захламления страниц неактуальной информацией. Team Fortress 2 постоянно обновляется и изменения, вносимые в игровую механику, происходят слишком часто, чтобы стоило заострять внимание на каждом из них.

Стратегии сообщества

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

Многие из существующих стратегий сложно или невозможно описать словами, поэтому не воспринимайте всё написанное как единственно верный вариант действий. Лучшие стратегии поведения не требуют того, чтобы противник был глуп, наивен или неопытен; например, стратегии с использованием обмана не всегда работают, поскольку опытные противники, скорее всего, будут к ним готовы. Стоит учитывать, что разовый результат еще ничего не гарантирует, поскольку любой стиль игры может быть успешен против команды достаточно неопытных противников. Лучшим советом будет тот, который окажется полезен и при игре против профессионалов.

Особые случаи

Чтобы избежать неоднозначности, в некоторых случаях нужно придерживаться определенных правил.

• Настройки клавиш: Team Fortress 2 существует также на игровых консолях, а среди пользователей ПК немало тех, кто меняет клавиши, назначенные для определенных действий. Упоминания команд, используемых в игровом процессе, должны оставаться максимально простыми и универсальными, включая значения по умолчанию (допустимым вариантом может быть разовое указание клавиш в качестве уточнения в скобках). Например, вместо «нажмите Mouse2 и обойдите противника» лучше написать «обойдите противника, используя невидимость (клавиша по умолчанию: Mouse2 для ПК, контроллера XBox 360, контроллера PS3)» или, если кнопки уже были упомянуты выше, достаточно будет написать «обойдите противника, используя невидимость».
• «Основное» и «дополнительное» оружие: порядок для оружия не является однозначным, особенно в случаях с подрывником и шпионом, поэтому следует избегать слов «основное» и «дополнительное», если речь идет об оружии этих классов. Например, вместо фразы «используйте основное оружие, чтобы атаковать подошедших ближе противников», лучше написать «используйте гранатомет, чтобы атаковать подошедших ближе противников».

Следующий абзац касается только редактирования статей на английском языке.

• «Pipe bomb»: нужно избегать использования термина «pipe bomb» и его аналогов. Многие игроки подразумевают под ним снаряды гранатомета, однако в коде игры термин «pipes» используется для обозначения бомб-липучек. Например, чтобы избежать неоднозначности, вместо фраз «pipes do not suffer damage fall-off» и «use cloak to get past pipes» лучше написать «grenades do not suffer damage fall-off» и «use cloak to get past stickies».

См. также

• Руководство по написанию статей (карты) (English)
• Руководство по написанию статей (оружие) (English)
• Руководство по написанию статей от А до Я (English)
• Руководство по написанию статей (факты) (English)
• Руководство по написанию статей (ошибки игры) (English)