0. Правила оформления страниц

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

Основные моменты, касающиеся публикации

  1. Каждая страница должна начинаться с указанием страницы оригинального перевода и записываться в таком виде: Источник здесь.
  2. Затем, в этой же строке, в квадратных скобках должна следовать информация о переводчике в таком виде: [переводчик: Иван Иванов]. Если переводчиков несколько, то размещать так:  [переводчики: Иван Иванов, Пётр Петров, Сидор Сидоров]
  3. Буквы "ё" не писать как "е" - это повлияет на результаты поиска (в своих переводах я изначально использовал это правило, так что давайте уж его придерживаться и далее, дабы не переписывать уже переведённое мною). Можно было бы, конечно, писать и "е" вместо "ё", но тогда выполнять поиск придётся для двух вариантов, а это неудобно. Поэтому - пусть "ё" будет "ё", а "е" - будет "е".
  4. В той же строке, где указан переводчики следует размещать информацию о статусе страницы:[перевод достоверен], или [свободна], т.е. данную страницу ещё никто не брался переводить, или [переводит Коля Петров] (т.е. перевод ещё не опубликован, но находится в стадии процесса), или [перевод не проверен] или [проверил Олег Олегович] или [проверяет Олег Олегович] (дабы не получилось так, что Олег начал проверять/переводить страницу, не зная, что её, оказывается, уже переводит Вася). Если проверяло несколько человек, то: [проверили: Олег Олегович, Игорь Игоревич]. Причём, следует использовать и цветовое выделение, как это сделано в приведённых мною примерах - так визуально наглядней.
  5. Все ссылки должны открываться в новых вкладках, а не на той же странице (всё, что я переводил и опубликовывал ранее, организовано именно так).
  6. Комментарии, вставляемые в исходный текст переводчиком должны выглядеть так: [прим. переводчика: Тут оставляемые мною комментарии].
  7. Все наименования разделов, опубликованных на страницах должны быть оформлены в таком стиле: Некоторое наименование параграфа, и находиться на отдельной строке, с предшествующей и последующей пустыми строками.
  8. Исходникам кода должна предшествовать надпись Код VB.Net или Код C# или Код VBA / ActiveX, выделенная так же в отдельную строку.
  9. Исходники кода должны быть оформлены с помощью этой страницы (установив опции нумерации строк и их подсвечивания) - пример оформления можно увидеть  здесь.
  10. Все размещаемые изображения следует копировать, а не оставлять ссылки на оригинал. Это делается из меню Вставить через субменю Изображение. Вставляемое изображение следует располагать центрально и выбирать пункт "L" в категории "Размер" редактора размещения изображения.
  11. Метку [перевод достоверен] имеет право ставить только чётко определённая группа людей, обладающая необходимым опытом. На данный момент, люди, за которыми я признаю сие право, это: Полещук Н.Н. и Александр Ривилис (если они вообще захотят этим заниматься). Себя отношу к категории обычных переводчиков и для переведённых мною страниц буду ставить метку [перевод не проверен].
  12. После публикации перевода или его проверки, необходимо в обязательном порядке сделать об этом соответствующую запись в Истории изменений, не забыв обновить файл (удалить более старую версию, заменив её более новой) "Информация о переведённых разделах.xls" выложенный в самом низу той же страницы и демонстрирующий общее состояние перевода мануала на текущий момент.
  13. Комментарии в коде так же следует переводить и выделять как
    код цитаты
    для удобочитаемости.
  14. Текстовую информацию в коде (например сообщения выводимые на консоль; текст сообщения об ошибке и т.п.) так же следует переводить.

Для чего следует это исполнять?

Удобство поиска

  • Выполнение пунктов 3 и 4 позволит эффективно использовать поиск. 
  • Если я, к примеру, хочу найти страницы, которые еще не переводили, то в поисковую строку введу это: [свободна]
  • Если же я хочу найти страницы, нужнающиеся в проверке достоверности перевода, то в поисковике наберу: [перевод не проверен] или же [сомнения в переводе]
  • Если мне нужно найти страницы, которые на данный момент проверяет Вася Пупкин, я наберу в строке поиска: [Переводит Вася Пупкин].
    Это позволит избежать путаницы (например - не проверять одно и тоже по 100 раз, а так же не дублировать чужой перевод) и более быстро ориентироваться в мануале. Все остальные пункты предназначены для того, чтобы придерживаться единого стиля оформления, что предоставляет некоторое удобство в процессе чтения.

Comments