Это черновик! Если есть идеи - смело правьте эту страницу, но добавляйте информацию только с подписью (есть в инструментах)

Документация Ubuntu.ru становится всё более популярной как внутри круга почитателей Ubuntu, так и далеко за его пределами. В связи с этим, способствуя дальнейшему перспективному развитию ресурса, члены Сообщества принимают и обязуются соблюдать нижеследующие Правила и рекомендации:

Создание статьи

Документация Ubuntu.ru - собрание различной пользовательской документации, инструкций по настройке и конфигурированию, описанию характеристик и возможностей всего, что так или иначе может быть связано с официальным семейством операционных систем Ubuntu а также система управления такими материалами. Перед написанием новой статьи убедитесь, нет ли уже написанной ранее под другим названием. Пользуйтесь поиском. Возможно, стоит подумать о дополнении уже существующего материала, нежели создания нового.
Для создания ещё не существующей статьи необходимо на неё перейти. Просто введите её имя в адресную строку браузера, а затем, когда система оповестит вас об её отсутствии, нажмите специальную кнопку «Создать страницу» в выпадающем меню панели инструментов или в нижнем левом углу страницы.

Если система не позволяет создать страницу - проверьте, обладаете ли вы должными правами доступа. К редактированию wiki/ допускаются все пользователи forum.ubuntu.ru за исключением тех, кто был ограничен в таких правах за те или иные нарушения. Доступ к разделам, отличным от wiki/, частично закрыт и дан только Редакторам.

Минимальный объём и значимость

Думаю, статья должна быть не меньше 500 символов, как на википедии. В противном случае - удаляем.
Malamut 2012/05/12 13:40
В противном случае предлагаем добавить её в уже существующую, наиболее близкую по смыслу.
Пупизоид 2012/05/15 13:18

Публиковать рекомендуется только статьи, представляющие интерес широкого круга членов Сообщества. Не стоит писать и опубликовывать материал, интересный лишь его автору; степень значимости статьи можно примерно определить количеством ссылок на неё с других статей. Чем больше таких ссылок - тем важнее статья, тем большую она несёт в себе информационную ценность.
Объём статей должен превышать 10-15 примерно 20 строк полезного текста. Статьи, не преодолевшие порог, будут поставлены в очередь на удаление или перенесены в содержание другой статьи.

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
В названии статей не должно быть никаких слов, обозначающих действие. Как-то: установка, настройка и т.д. В качестве общего исключения могут выступать статьи, образованные в результате разделения одной очень большой статьи на части путём выделения самых больших разделов.
Malamut 2012/05/22 14:10

Создавая новую страницу, внимательно отнеситесь не только к её наполнению, но и наименованию с заголовком - визитной карточке страницы Документации. Имя статьи - слово или словосочетание, отображаемое после имени раздела 'wiki/', например, 'wiki/правила', где правила - имя статьи в системе Документации. Имя статьи задаётся её автором. Заголовком статьи считается первый заголовок 1-го уровня, отображающийся в шапке материала и, кроме того, на других индексных страницах.
Возбраняется организация вложенных пространств имён (создавать имя одной страницы за именем другой - wiki/правила/другие_правила) в связи с прямой отсылкой такого размещения к структуре категорий, от которой на данный момент назначен переход к системе тегов.
Необходимо отметить: имя статьи, в отличии от её заголовка, вы сохраняете раз и навсегда. В силу технических ограничений переименовать в последующем времени статью можно, но с большими потерями, из-за чего производиться эта процедура будет исключительно редко. Следовательно, имя статье нужно давать исходя из представлений длительного содержания - не упоминайте названия конкретных версий продукта за исключением тех, которые подробно освещают именно какую-то одну версию определённой программы1).

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

Структура статьи

Для поддержания целостности и единообразия статей в разделе Документации в создаваемой странице необходимо использовать следующий шаблон:

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

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

* Первичный заголовок 1-го уровня * Общая информация - краткое изложение сведений и положений о предмете статьи. Здесь может быть использована информация с официальных сайтов, файлов помощи программ, иных вики-ресурсов и т.п. * Произвольно - в силу неординарности построения статей, решения о создании определённых подзаголовков ложатся на плечи автора или редактора, если автором эта важная составляющая была упущена. * См.также - здесь можно указать сторонние источники, дополнительные материалы по теме, и, например, ссылку на тему обсуждения страницы на форуме.

Наполнение и содержание

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

Ни в коем случае не забывайте про ссылки! Чем больше в статье ссылок, приоритетно - на внутренние ресурсы, тем прочнее она входит в систему Документации, тем крепче и стабильнее наблюдается взаимосвязь между разнообразными материалами.

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

Формирование верной структуры, оформления, использование возможностей синтаксиса и, конечно же, достойное содержание и соблюдение общепринятой стилистики статей определяют успех статьи.
Всегда стоит помнить, что многие пользователи используют не самую последнюю версию Ubuntu. Особенно это замечание актуально для серверных версий. Поэтому если вы хотите обновить статью, заменив какие-то устаревшие части на актуальные для текущего релиза Ubuntu, то всегда оставляйте комментарии с информацией о том, как нужно поступать при использовании старых версий. Проще говоря: никогда не удаляйте полезную информацию из статьи, если она актуальна хоть для какой-нибудь версии Ubuntu. Вместо этого переносите её в отдельные разделы или заметки, с пометкой об области применимости.
Malamut 2012/05/24 10:43

Иллюстрации и снимки экрана

Все статьи следует сопровождать пояснительными снимками экрана либо иллюстрирующими изображениями2).
Элементы оформления статей (галочки, крестики, логотипы Ubuntu и т.д.) необходимо брать (и добавлять свои) в пространстве wiki:оформление:.

Основные требования: все скриншоты должны быть сделаны при использовании стандартной темы рабочего стола Unity со стандартным набором иконок с одним из стандартных фонов, дабы не отвлекать читателя на изучение особенностей оформления. Он должен видеть то, что будет видеть на экране своего монитора.

Не нужно, врядли кому то захочется «разбирать» своё оформление для того, что бы статью написать
Пупизоид 2012/05/16 13:46

Значительные отклонения допускаются лишь в материалах, посвящённых настройке внешнего вида, и, собственно, отражающих результаты такого изменения.
Загружаемые и сохраняемые на сервер Ubuntu.ru снимки экрана и иные изображения должны быть размещены строго в отведённых для них разделах - вложенных именах статей - во избежание хаоса в корневой директории. То есть изображения, приведённые на странице wiki/правила должны находиться в пространстве имён wiki/правила/, а не в wiki/. Для того, чтобы поместить изображение в нужную директорию, следует перейти http://help.ubuntu.ru/?do=media&ns=wiki:название_статьи.\\

При добавлении изображения необходимо:
1) Поискать существующие изображения
Выбрать «раздел» wiki, ввести в строке поиска (находится после всех изображений) имя искомой программы, или название диалога (имя последней нажатой клавиши или имя, отображающееся в шапке окна), проверить отсутствие необходимой картинки;
2) Выбрать «раздел» добавления файла:
2.1) Для создаваемой вновь страницы:
В пространстве имен wiki создать имя, аналогичное названию редактируемой страницы (при первом добавлении файла указать перед именем :имя_страницы:имя_файла.png)
2.2) Для существующей страницы
Находясь в разделе wiki в строке поиска (после всех файлов) ввести имя статьи, или кусок имени, отображаемого в адресной строке вашего браузера
3) Указать имя файла:
В имени файла необходимо указывать название программы и название диалога (имя последней нажатой кнопки, или имя, отображаемое в шапке окна), изображенного на картинке. Для редактированных изображений необходимо добавить суффикс «_edt». Например: ubuntu_tweak_прочее.png, ubuntu_рабочий_стол.png, ubuntu_desktop_edt.png, ccsm_ubuntu_unity_plugin.png.

Пупизоид 2012/05/16 13:52
тлдр, нет правда. Подсократить бы, раза в три. Притом, плагин же менять будут?:-? Я надеюсь. — forekko

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

DELETEMEforekko

Логотипы программ - в /wiki, скриншоты и все остальные иллюстрации - в wiki/program_name.
Malamut 2012/05/18 01:33

Статьи про программы

Имя страницы статьи про программу, сервис и т.д. должна соответствовать шаблону:

help.ubuntu.ru/wiki/имя_программы

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

Шаблон статьи про программу

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

======Установка======
Название пакета, команда для установки, особенности в процессе установки (что можно доставить, что можно удалить из зависимостей и т.д.)

======Настройка======
Настройка программы для повседневного использования (скриншоты конфигурационных диалогов, тексты конфигов и т.д.)

======Использование======
Описание нестандартного применения программы, внутри какого то комплексного решения, для каждого применения создается свой подраздел.
=====Вариант №1=====
=====Вариант №2=====
=====Вариант №n=====

======Особенности версии======
В этом разделе указываются особенности настройки и использования программ различных версий, для каждой версии создается свой подраздел.
=====Версия Х=====
=====Версия Х+1=====
=====Версия X+n=====

======Ссылки======
Ссылка на обсуждение темы, если есть раздел "Использование".

----
{{tag>программы}}

При возникновении своего видения настройки программы необходимо создать дополнительный раздел «Настройка(альтернативная)».
Тэг программы– обязателен!

Статьи про конкретные программы (сервисы и т.д.)

Видимо, стоит запретить создание статей по отдельным версиям программ. Всю информацию по версиям нужно писать в 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

Статьи в разделе "Совместимость"

Этот раздел вообще не трогаю; мне кажется, его стоит вынести в отдельные рекомендации конкретно раздела. — forekko

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

help.ubuntu.ru/совместимость/hp_pavilion_dv6_2055er

Ссылка на статью должна быть обязательно добавлена в статью

help.ubuntu.ru/совместимость/производитель_устройства
Так тэги же нужно использовать, а страницы производителей устройств сделать индексными просто, страницы без тэгов- удалять.
Пупизоид 2012/05/16 14:15

Шаблон статьи

======Название устройства======
В имени статьи указывается только модель устройства (Без производителя)
Далее указывается:
Совместимость с Ubuntu: нет проблем\решаемые проблемы\нерешаемые проблемы
======Графика======
Описываются проблемы (и их решения) с графикой
======Звук======
Описываются проблемы (и их решения) со звуком
======Сеть======
Описываются проблемы (и их решения) с сетевыми устройствами
======Bluetooth======
Описываются проблемы (и их решения) с функцией передачи файлов
======Прочее оборудование=====
Описываются проблемы (и их решения) с прочим оборудованием (кардридеры, клавиатуры и т.д.)
======Ссылки======
Ссылки на сторонние материалы по решению проблем.
{{tag>имя_производителя}}

Примечания: 1) для «нет проблем\решаемые проблемы\нерешаемые проблемы» можно придумать картинки веселые, и в шаблоне привести все три, нужно будет удалить лишнее только.

Неструктурированные наброски идей по мотивам правил википедии

Статьи следует писать на литературном русском языке в научном стиле от третьего лица.

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

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

Последовательность изложения:

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

1)
например, wiki/precise. Стоит помнить про значимость!
2)
к иллюстрирующим изображениям можно отнести, к примеру, логотип программы с официального сайта