Это старая версия документа.
Содержание
Документация Ubuntu.ru снискивает всё большую популярность как внутри круга почитателей Ubuntu, так и далеко за его пределами. В связи с этим, способствуя дальнейшему перспективному развитию ресурса, члены Сообщества принимают и обязуются соблюдать нижеследующие Правила и рекомендации:
Создание статьи
Документация Ubuntu.ru - собрание различной пользовательской документации, инструкций по настройке и конфигурированию, описанию характеристик и возможностей всего, что так или иначе может быть связано с официальным семейством операционных систем Ubuntu а также система управления такими материалами.
Перед написанием новой статьи убедитесь, нет ли уже написанной ранее под другим названием. Пользуйтесь поиском. Возможно, стоит подумать о дополнении уже существующего материала, нежели создания нового.
Для создания ещё не существующей статьи необходимо на неё перейти. Просто введите её имя в адресную строку браузера, а затем, когда система оповестит вас об её отсутствии, нажмите специальную кнопку «Создать страницу» в выпадающем меню панели инструментов или в нижнем левом углу страницы.
Минимальный объём и значимость
Публиковать рекомендуется только статьи, представляющие интерес широкого круга членов Сообщества. Не стоит писать и опубликовывать материал, интересный лишь его автору; степень значимости статьи можно примерно определить количеством ссылок на неё с других статей. Чем больше таких ссылок - тем важнее статья, тем большую она несёт в себе информационную ценность.
Объём статей должен превышать 10-15 строк полезного текста. Статьи, не преодолевшие порог, будут поставлены в очередь на удаление.
10-15 строк- мало, мне кажется
— Пупизоид 2012/05/16 13:43
Наименование статей
Никаких версий ubuntu в названиях статей никогда быть не должно. Кроме статей, которые непосредственно посвящены описанию конкретных версий (не программ для них и не их настройки).
— Malamut 2012/05/12 14:05
Вложенные пространства имён полностью запрещены! Все статьи и картинки обязательно должны располагаться в пространстве имён wiki. Исключение по договорённости с редакторами могут составить только крупные руководства, по типу http://help.ubuntu.ru/manual.
— Malamut 2012/05/15 11:52Ну в картинках то ковардак будет, их там нужно систематизировать, потому что структура папок то видна.
— Пупизоид 2012/05/15 13:04
Создавая новую страницу, внимательно отнеситесь не только к её наполнению, но и наименованию с заголовком - визитной карточке страницы Документации. Имя статьи - слово или словосочетание, отображаемое после имени раздела 'wiki/', например, 'wiki/правила', где правила - имя статьи в системе Документации. Имя статьи задаётся её автором. Заголовком статьи считается первый заголовок 1-го уровня, отображающийся в шапке материала и, кроме того, на других индексных страницах.
Возбраняется организация вложенных пространств имён (создавать имя одной страницы за именем другой - wiki/правила/другие_правила) в связи с прямой отсылкой такого размещения к структуре категорий, от которой на данный момент назначен переход к системе тегов.
Необходимо отметить: имя статьи, в отличии от её заголовка, вы сохраняете раз и навсегда. В силу технических ограничений переименовать в последующем времени статью можно, но с большими потерями, из-за чего производиться эта процедура будет исключительно редко. Следовательно, имя статье нужно давать исходя из представлений длительного содержания - не упоминайте названия конкретных версий продукта за исключением тех, которые подробно освещают именно какую-то одну версию определённой программы1).
Структура статьи
Для поддержания целостности и единообразия статей в разделе Документации в создаваемой странице следует использовать такие заголовки, как:
- Общая информация - краткое изложение сведений и положений о предмете статьи. Здесь может быть использована информация с официальных сайтов, файлов помощи программ, иных вики-ресурсов и т.п.
- Произвольно - в силу неординарности построения статей, решения о создании определённых подзаголовков ложатся на плечи автора или редактора, если автором эта важная составляющая была упущена.
- См.также - здесь можно указать сторонние источники, дополнительные материалы по теме, и, например, ссылку на тему обсуждения страницы на форуме.
Система Документации под управлением DokuWiki поддерживает автоматическое создание оглавления статьи при наличии трёх и более заголовков. Помните, что именно заголовки определяют структуру и оглавление статьи, не пренебрегайте их использованием.
Наполнение и содержание
Следует учитывать следующее: короткий, но максимально полный; содержательный, но без лишнего материал увеличивает шансы прочтения пользователем статьи до конца, и, возможно, решения своей проблемы.
Статья должна содержать лишь сведения, так или иначе относящиеся к теме страницы.
Любой другой материал, уже изложенный в другой статье, заново пересказывать не стоит - лучше просто дать ссылку.
Если вы обнаружили в себе рвение и возможность описать что-то не совсем подходящее к редактируемой статье - подумайте, нужно ли это остальным? - и, если нужно - напишите отдельную, с подробным раскрытием вопроса.
Все статьи следует, по возможности, сопровождать наглядными иллюстрациями.
Иллюстрации и снимки экрана
Все статьи следует сопровождать пояснительными снимками экрана либо иллюстрирующими изображениями2).
Основные требования: все скриншоты должны быть сделаны при использовании стандартной темы рабочего стола Unity со стандартным набором иконок с одним из стандартных фонов, дабы не отвлекать читателя на изучение особенностей оформления. Он должен видеть то, что будет видеть на экране своего монитора.
Не нужно, врядли кому то захочется «разбирать» своё оформление для того, что бы статью написать
— Пупизоид 2012/05/16 13:46
Значительные отклонения допускаются лишь в материалах, посвящённых настройке внешнего вида, и, собственно, отражающих результаты такого изменения.
Загружаемые и сохраняемые на сервер Ubuntu.ru снимки экрана и иные изображения должны быть размещены строго в отведённых для них разделах - вложенных именах статей - во избежание хаоса в корневой директории. То есть изображения, приведённые на странице wiki/правила должны находиться в пространстве имён wiki/правила/, а не в wiki/. Для того, чтобы поместить изображение в нужную директорию, следует перейти http://help.ubuntu.ru/?do=media&ns=wiki:название_статьи.
Необходимо напомнить, что изображения, найденные в сети Интернет, сохранять на сервере ресурса Документации не обязательно, их можно поместить и отображать в статье напрямую с другого сайта. При таком использовании подразумевается указание ссылки на сайт.
Статьи про конкретные программы (сервисы и т.д.)
Видимо, стоит запретить создание статей по отдельным версиям программ. Всю информацию по версиям нужно писать в wiki/programname в отдельные разделы, и только если раздел получается очень большим, можно выделить его в отдельную статью, дабы не захламлять спецификой основную статью. При этом нужно поставить в начале новой статьи ссылку на основную статью по программе, а в самой основной статье на нужном месте - ссылку на выделенную статью (опять же, как в википедии).
При этом статьи про любые программы должны иметь название либо wiki/programname, либо (см. выше) - wiki/programnameVersion. Например wiki/gimp и wiki/gimp2.8. Никаких «установка firefox3.5 в ubuntu 5.10».
— Malamut 2012/05/12 13:46
Разные инструкции по настройке одной и той же программы
Будут случаи, когда у разных пользователей разное мнение на тему того, как нужно настраивать, например, Apache. В этом случае, видимо, стоит отдельные способы выделять тупо в отдельные разделы в рамках одной статьи. При этом запретить выделять их в отдельные статьи, дабы не было конфликта - какой способ основной.
Если же нужна инструкция по специфичной настройке для какого-то случая - то в отдельную статью. Например: интеграция_ejabberd_с_active_directory
— Malamut 2012/05/12 13:49