Главная

Правила стиля редактирования (с комментариями)

Комментарии написаны редактором tanstaaf1, катмодом World/Russian, с уточнениями других редакторов (см. внутренний форум). Они не являются официальными правилами стиля (англ., рус.), но стремятся пояснить их исходя из сложившейся практики редактирования и опыта автора. Цитаты из правил — в пунктирных блоках.

В Открытом каталоге информация о сайте имеет такой вид:

Заголовок - Описание.

Для составления заголовков и описаний существуют правила стиля, которые мы ниже процитируем с пояснениями.

Заголовки

Заголовок должен называть сайт, а не описывать его. Он должен быть одновременно информативным и кратким.

Чтобы составить хороший заголовок:

Обычно название сайта написано в его верхней части самым заметным шрифтом.

Если там несколько возможных вариантов — предпочитаемое самоназвание иногда дублируется на странице «О проекте» или в подвале в виде знака авторских прав: © «Название сайта».

Под названием сайта не подразумевается содержимое тэга <title>, показываемое в шапке окна браузера.

  • Указывайте в качестве заголовка официальное название компании или сходного образования, если сайт посвящён этой компании, организации или образованию (например, собственная страница компании).
  • Название компании указывается без уточнений типа ООО или ЗАО.

    Как правило, название компании можно найти на странице с контактной информацией.

    Если сайт посвящен человеку, то в качестве заголовка используется его имя.

    Если в разделе много сайтов, посвященных людям (например, в разделе Актеры), то используется формат Фамилия Имя [Отчество] для облегчения поиска.

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

    Московский государственный университет (МГУ) - Описание...

  • Если же название неоднозначно или производит впечатление спама, составьте краткий заголовок исходя из содержимого сайта.
  • Например, в спорных случаях можно использовать в заголовке название домена:

    Site.ru - Описание...

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

    Кавказская пленница, или Новые приключения Шурика
    Ирония судьбы, или С лёгким паром!

    В заголовках на английском языке начинайте каждое слово с заглавной буквы, не считая артиклей, предлогов и союзов, если они не стоят в начале заголовка или новой части составного заголовка.
    Star Wars: The Phantom Menace
    Cold Snow: The Fluffy White Stuff
    Sunlight on Snow: The Dangers of Glare and Eyestrain

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

  • Не используйте в заголовке избыточные ключевые слова, ненужные символы и буквы, слоганы компаний и рекламный язык.
  • В 99% случаев правильным заголовком является название сайта или название организации (имя человека), как описано выше. При этом любые дополнительные слова являются лишними.

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

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

    Петров Иван - Художник и поэт. [Содержание сайта]
  • Не используйте в начале заголовка знаки препинания, ненужные символы, буквы и спецсимволы. В некоторых случаях сайты сортируются по алфавиту, и иногда люди пытаются нечестным образом попасть наверх списка. Если предлагается сайт с заголовком «ааа Сайт», но на самом деле он называется «Сайт», тогда наилучшим заголовком будет «Сайт».
  • Не используйте заголовки из одних заглавных букв.
  • Не ставьте в конце восклицательный знак или любую другую лишнюю пунктуацию. В конце заголовка точка (как знак окончания предложения) не ставится.
  •  

    Описания

    Описание содержит конкретную информацию о содержимом и/или тематике сайта. Оно должно быть информативным и кратким, обычно не длиннее одной-двух строк. Принципиальная формула хорошего описания такова: Описание = Тема + Содержимое.

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

    Еще на сайтах компаний обычно бывают контактная информация и прайс-лист. Не нужно упоминать это в описании.

    Ниже изложены базовые принципы составления хороших описаний.
    Хорошие описания:

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

    Это главное в описаниях — поэтому этот пункт идет первым.

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

    Это непростая и интересная задача, которая требует вычищать из описаний все незначимое, чтобы на 1-2 строчках четко и полно изложить тему и основное содержимое сайта (или предмет деятельности организации, которой сайт посвящен).

    1. (Хорошие описания) имеют логичную структуру предложений и выражений, а также пунктуацию и заглавные буквы в нужных местах, чтобы пользователям было проще читать содержимое разделов.
      • Начинайте описания с заглавной буквы и заканчивайте точкой.
      • Везде, где возможно, используйте местоимения 3-го лица и избегайте местоимений 1-го и 2-го лица (таких как «вы», «ваш», «мы», «нам», «наш», «я» или «мне»), поскольку они слишком субьективны.

    Т.е. не надо писать «на сайте вы найдете...» или «наш сайт предлагает».

    Открытый каталог не имеет отношения к сайту, поэтому сайт не наш. :-)

    Многие браузеры имеют встроенные средства проверки орфографии. При заполнении формы обратите внимание, не подчеркнуты ли какие-то слова красным.
      • Избегайте аббревиатур и сокращений — кроме тех, которые понятны большинству потенциальных пользователей раздела.
    1. (Хорошие описания) не выглядят как реклама, завлекательный текст с целью продажи, мнения или редакторские рецензии. ODP не рекламирует и не рецензирует сайты.
      • Избегайте превосходных степеней, обычно используемых в рекламе, таких как «лучший», «самый», «отличнейший», «выгоднейший»

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

    Например, «всё о [тема сайта]».

    На самом деле, ни один сайт не содержит «всё» по какой-либо теме.

      • Не используйте экспрессивную пунктуацию (например, «!!!» ), сплошные заглавные буквы с целью логического ударения, амперсанды ( «&» ) и многоточия ( «...» ).
      • Не давайте собственную рецензию какого-либо аспекта веб-сайта.

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

    Например, вы можете захотеть упомянуть, что на сайте есть «полезные советы».

    Но мы не должны давать оценку полезности содержимого от лица каталога — поэтому правильно написать просто «советы».

    Вообще, само по себе размещение сайта в каталоге означает, что на нем есть что-то полезное. Если что-то упоминается в описании сайта — значит, это наиболее интересное из его содержимого. Поэтому любые другие положительные эпитеты являются лишними.

    Не следует давать неопределенных количественных оценок, вроде «большая коллекция материалов».

    Термин «большой» субъективен и соответственно представляет собой рецензию со стороны редактора.

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

    Например, если сайт находится в разделе Страны и регионы: ... Москва: Компьютеры: Торговля, то в описании не нужно писать «продажа компьютеров в Москве» — это и так уже понятно.

    Хотя в некоторых случаях повторы допустимы, например: «настольные компьютеры и ноутбуки», «доставка по Москве и ближнему Подмосковью».

    Например, во многих случаях является лишней фраза типа «компания предлагает». Начните сразу с перечня видов деятельности, например:

    Название фирмы - Поставка того-то, установка, проектирование и обслуживание. Нижний Новгород.

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

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

    Более точное указание местоположения в описаниях считается излишним.

    (Хорошие описания):
    1. Не содержат указаний на нелегально приобретенное содержимое (например, пиратские версии программного обеспечения или музыки).
    2. Могут включать в себя небольшие цитаты с сайта (например, краткую цитату со страницы «О компании» или схожих информационных разделов), если перефразирование вызывает чрезмерные трудности.