Difference between revisions of "JaWiki:TechRules"

Revision as of 07:57, 8 August 2006

Правила JaWiki

Данные правила продиктованы не желанием в чем-то ущемить участников, а вполне адекватными причинами. Которые и указаны в комментарии к правилам.

Имена wiki должны быть англоязычными

Имена wiki следует выбирать англоязычные. Например, в случае если хочешь написать правила, то лучше использовать [[Rules]], а не [[Правила]].

Связано это в первую очередь с удобством навигации. Дело в том, что русские буквы нельзя использовать в качестве www-адреса, поэтому используется экранирование символов. Поэтому слово "Правила" будут экранировано и приведены к виду "%D0%9F%D1%80%D0%B0%D0%B2%D0%B8%D0%BB%D0%B0" что нечитабельно в принципе. Помимо этого, если Mozilla показывает ссылки русскими буквами в строке состояния, то Opera показывает экранированными, что тоже нехорошо. (FixMe А как показывают такие ссылки IE и MyIE)

Wiki-имена служебных страницы позволительно делать русскими, с обычными страницами лучше избегать этого. Правило "англиского названия" распространяется и на служебные страницы.

Страницы должны быть категоризированы

Следует все материалы разделять на категории. Чтобы отнести материал к категории (можно больше чем одной), следует добавить [[Category:CategoryName]], где CategoryName -- название категории, к которой относится статья, на английском языке. Одна статья може относится к разным категориям.

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

Разделение по категориям упрощает навигацию и структурирует материал.

Изменения должны иметь описание

Вносимые изменения должны иметь описание (поле "Краткое описание" ниже основного поля редактирования). Исправление ошибок -- bugfix, исправление опечаток -- typo. В случае малозначимых исправлений, желательно поставить флажок "Это - малозначимое изменение". Связано это с удобством чтения журнала изменений

Комментарии должны быть подписаны

При добавлении комментария, подписывайтесь. Это не сложно: добавьте пустую строку и --~~~~ в конце комментария. Или просто нажмите соответствущую кнопку (вторая справа, 'Your signature with timestamp') на панели инструментов редактирования.

Наличие подписей к комментариям упрощает их идентификацию. В любом случае, автор комментария будет отмечен в истории правок.

У каждой страницы должен быть смотритель

Для тех статей, автором или соавтором которых вы являетесь включайте функцию наблюдения. При этом ваш JID должен быть подтвержден в вашем Wiki-аккаунте! Изначально все адреса являются неподтвержденными. Для подтверждения адреса перейдите на страницу настроек и щелкните по ссылке "Подтвердить JID". Перейдите по полученной после этого ссылке. Теперь при изменении страниц, которые находятся в вашем списке наблюдения вы будете получать уведомление. Старайтесь их просматривать и откатывать те изменения, которые являются явно вандальными или ошибочными.

Спорные или субъективные правки

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

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

Данный свод правил был впервые было опубликовано по адресу http://wiki.omsktele.com/index.php/OTCwiki:Rules Их автор J2A.