Различия

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

--- wiki:новые_правила [2012/05/16 13:48]
[Иллюстрации и снимки экрана]
+++ wiki:новые_правила [2014/07/13 04:59]
удалил подпись
@@ Строка 2: / Строка 2: @@
 <note important>Это черновик! Если есть идеи - смело правьте эту страницу, но добавляйте информацию только с подписью (есть в инструментах)</note>
-**Документация Ubuntu.ru** снискивает всё большую популярность как внутри круга почитателей Ubuntu, так и далеко за его пределами. В связи с этим, способствуя дальнейшему перспективному развитию ресурса, члены Сообщества принимают и обязуются соблюдать нижеследующие **Правила и рекомендации**:
+**Документация Ubuntu.ru** становится всё более популярной как внутри круга почитателей Ubuntu, так и далеко за его пределами. В связи с этим, способствуя дальнейшему перспективному развитию ресурса, члены Сообщества принимают и обязуются соблюдать нижеследующие **Правила и рекомендации**:
 ===== Создание статьи =====
@@ Строка 17: / Строка 17: @@
 >>  --- [[user>Пупизоид]] //2012/05/15 13:18//
 Публиковать рекомендуется только статьи, представляющие интерес широкого круга членов Сообщества. Не стоит писать и опубликовывать материал, интересный лишь его автору; степень значимости статьи можно примерно определить количеством ссылок на неё с других статей. Чем больше таких ссылок - тем важнее статья, тем большую она несёт в себе информационную ценность.\\
-Объём статей должен превышать 10-15 строк полезного текста. Статьи, не преодолевшие порог, будут поставлены в [[http://help.ubuntu.ru/?do=showtag&tag=deleteme|очередь на удаление]].
+Объём статей должен превышать <del>10-15</del> примерно 20 строк полезного текста. Статьи, не преодолевшие порог, будут поставлены в [[http://help.ubuntu.ru/?do=showtag&tag=deleteme|очередь на удаление]] или перенесены в содержание другой статьи.
 > 10-15 строк- мало, мне кажется
 >  --- [[user>Пупизоид]] //2012/05/16 13:43//
@@ Строка 29: / Строка 29: @@
 >> Ну в картинках то ковардак будет, их там нужно систематизировать, потому что структура папок то видна.
 >>  --- [[user>Пупизоид]] //2012/05/15 13:04//
+> В названии статей не должно быть никаких слов, обозначающих действие. Как-то: установка, настройка и т.д. В качестве общего исключения могут выступать статьи, образованные в результате разделения одной очень большой статьи на части путём выделения самых больших разделов.
+> --- [[user>Malamut]] //2012/05/22 14:10//
 Создавая новую страницу, внимательно отнеситесь не только к её наполнению, но и наименованию с заголовком - визитной карточке страницы Документации. Имя статьи - слово или словосочетание, отображаемое после имени раздела 'wiki/', например, 'wiki/**правила**', где **правила** - имя статьи в системе Документации. [[#Создание статьи|Имя статьи задаётся её автором]]. Заголовком статьи считается первый [[syntax#Разбивка на разделы|заголовок 1-го уровня]], отображающийся в шапке материала и, кроме того, на других индексных страницах. \\
@@ Строка 36: / Строка 39: @@
 ===== Структура статьи =====
-Для поддержания целостности и единообразия статей в разделе Документации в создаваемой странице следует использовать такие заголовки, как:<note tip>Это лишь рекомендуемая структура, в точности её можно не соблюдать.</note>
+Для поддержания целостности и единообразия статей в разделе Документации в создаваемой странице необходимо использовать следующий шаблон:
-  * **[[#Наименование статей|Первичный заголовок 1-го уровня]]**
+<file>
+======Имя статьи======
+Тут необходимо изложить основную информацию о рассматриваемом ниже предмете и (или) вопросе. Первые абзацы статьи играют роль вступительной части, приводятся ссылки в вики на используемые термины.
+=====//Произвольно//=====
+В силу неординарности построения статей, решения о создании определённых подзаголовков ложатся на плечи автора или редактора, если автором эта важная составляющая была упущена.
+======Ссылки======
+здесь можно указать сторонние источники, дополнительные материалы по теме, и, например, ссылку на тему обсуждения страницы на форуме.
+</file>
+Система Документации под управлением DokuWiki поддерживает автоматическое создание оглавления статьи при наличии трёх и более заголовков. Помните, что именно заголовки определяют структуру и оглавление статьи, не пренебрегайте их использованием. \\
+<del>  * **[[#Наименование статей|Первичный заголовок 1-го уровня]]**
   * **Общая информация** - краткое изложение сведений и положений о предмете статьи. Здесь может быть использована информация с официальных сайтов, файлов помощи программ, иных вики-ресурсов и т.п.
   * //Произвольно// - в силу неординарности построения статей, решения о создании определённых подзаголовков ложатся на плечи автора или редактора, если автором эта важная составляющая была упущена.
-  * **См.также** - здесь можно указать сторонние источники, дополнительные материалы по теме, и, например, ссылку на тему обсуждения страницы на форуме.
+  * **См.также** - здесь можно указать сторонние источники, дополнительные материалы по теме, и, например, ссылку на тему обсуждения страницы на форуме.</del>
-Система Документации под управлением DokuWiki поддерживает автоматическое создание оглавления статьи при наличии трёх и более заголовков. Помните, что именно заголовки определяют структуру и оглавление статьи, не пренебрегайте их использованием.
@@ Строка 49: / Строка 61: @@
 Любой другой материал, уже изложенный в другой статье, заново пересказывать не стоит - лучше просто дать ссылку.\\
 Если вы обнаружили в себе рвение и возможность описать что-то не совсем подходящее к редактируемой статье - подумайте, [[#Минимальный объём и значимость|нужно ли это остальным]]? - и, если нужно - напишите отдельную, с подробным раскрытием вопроса.
+<note important>Ни в коем случае не забывайте про [[wiki:syntax#ссылки]]! Чем больше в статье [[wiki:syntax#ссылки|ссылок]], приоритетно - на [[wiki:syntax#внутренние|внутренние ресурсы]], тем прочнее она входит в систему Документации, тем крепче и стабильнее наблюдается взаимосвязь между разнообразными материалами.</note>
 Все статьи следует, по возможности, **[[#Иллюстрации и снимки экрана|сопровождать наглядными иллюстрациями]]**.
 <note important>Формирование [[#Структура статьи|верной структуры]], [[#Оформление|оформления]], использование возможностей [[wiki:syntax|синтаксиса]] и, конечно же, достойное [[#Наполнение и содержание|содержание]] и соблюдение общепринятой [[terms/стилистика_статей|стилистики статей]] определяют успех статьи.</note>
+> Всегда стоит помнить, что многие пользователи используют не самую последнюю версию Ubuntu. Особенно это замечание актуально для серверных версий. Поэтому если вы хотите обновить статью, заменив какие-то устаревшие части на актуальные для текущего релиза Ubuntu, то **всегда** оставляйте комментарии с информацией о том, как нужно поступать при использовании старых версий. Проще говоря: **никогда** не удаляйте полезную информацию из статьи, если она актуальна хоть для какой-нибудь версии Ubuntu. Вместо этого переносите её в отдельные разделы или заметки, с пометкой об области применимости.
+>  --- [[user>Malamut]] //2012/05/24 10:43//
 ===== Иллюстрации и снимки экрана =====
 Все статьи следует сопровождать пояснительными снимками экрана либо иллюстрирующими изображениями((к иллюстрирующим изображениям можно отнести, к примеру, логотип программы с официального сайта)). \\
+Элементы оформления статей (галочки, крестики, логотипы Ubuntu и т.д.) необходимо брать (и добавлять свои) в пространстве **wiki:оформление:**.
 >Основные требования: все скриншоты должны быть сделаны при использовании стандартной темы рабочего стола Unity со стандартным набором иконок с одним из стандартных фонов, дабы не отвлекать читателя на изучение особенностей оформления. Он должен видеть то, что будет видеть на экране своего монитора.
 >
-> Не нужно, врядли кому то захочется "разбирать" свой интерфейс для того, что бы статью написать
+> Не нужно, врядли кому то захочется "разбирать" своё оформление для того, что бы статью написать
 >  --- [[user>Пупизоид]] //2012/05/16 13:46//
  Значительные отклонения допускаются лишь в материалах, посвящённых настройке внешнего вида, и, собственно, отражающих результаты такого изменения. \\
-Загружаемые и сохраняемые на сервер Ubuntu.ru снимки экрана и иные изображения должны быть размещены строго в отведённых для них разделах - вложенных именах статей - во избежание хаоса в корневой директории. То есть изображения, приведённые на странице wiki/правила должны находиться в пространстве имён wiki/правила/, а не в wiki/. Для того, чтобы поместить изображение в нужную директорию, следует перейти <nowiki>http://help.ubuntu.ru/?do=media&ns=wiki:</nowiki>**название_статьи**.\\
+<del>Загружаемые и сохраняемые на сервер Ubuntu.ru снимки экрана и иные изображения должны быть размещены строго в отведённых для них разделах - вложенных именах статей - во избежание хаоса в корневой директории. То есть изображения, приведённые на странице wiki/правила должны находиться в пространстве имён wiki/правила/, а не в wiki/. Для того, чтобы поместить изображение в нужную директорию, следует перейти <nowiki>http://help.ubuntu.ru/?do=media&ns=wiki:</nowiki>**название_статьи**.\\</del>
+> При добавлении изображения необходимо:
+> 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.
+>
+> --- [[user>Пупизоид]] //2012/05/16 13:52//
+>> [[http://lurkmore.to/Tl;dr|тлдр]], нет правда. Подсократить бы, раза в три. Притом, плагин же менять будут?:-? Я надеюсь. --- [[user>forekko]]
 Необходимо напомнить, что изображения, найденные в сети Интернет, сохранять на сервере ресурса Документации не обязательно, их можно поместить и отображать в статье напрямую с другого сайта. При таком использовании подразумевается указание ссылки на сайт.
+DELETEME  --- [[user>forekko]]
+> Логотипы программ - в /wiki, скриншоты и все остальные иллюстрации - в wiki/program_name.
+>  --- [[user>Malamut]] //2012/05/18 01:33//
+=====Статьи про программы=====
+Имя страницы статьи про программу, сервис и т.д. должна соответствовать шаблону:
+<file>help.ubuntu.ru/wiki/имя_программы</file>
+При переполнении статьи большим объемом информации необходимо добавлять тэг ''объемная'', что бы редактор отделил раздувшийся раздел в отдельную статью.
+====Шаблон статьи про программу====
+<file>
+======Имя программы======
+В данном разделе указывается общая информация по программе (для чего нужна, кем и где используется, приводится официальный сайт и т.д.)
-DELETEME
+======Установка======
+Название пакета, команда для установки, особенности в процессе установки (что можно доставить, что можно удалить из зависимостей и т.д.)
+======Настройка======
+Настройка программы для повседневного использования (скриншоты конфигурационных диалогов, тексты конфигов и т.д.)
+======Использование======
+Описание нестандартного применения программы, внутри какого то комплексного решения, для каждого применения создается свой подраздел.
+=====Вариант №1=====
+=====Вариант №2=====
+=====Вариант №n=====
+======Особенности версии======
+В этом разделе указываются особенности настройки и использования программ различных версий, для каждой версии создается свой подраздел.
+=====Версия Х=====
+=====Версия Х+1=====
+=====Версия X+n=====
+======Ссылки======
+Ссылка на обсуждение темы, если есть раздел "Использование".
+----
+{{tag>программы}}
+</file>
+При возникновении своего видения настройки программы необходимо создать дополнительный раздел "Настройка(альтернативная)".\\
+Тэг ''программы''-- обязателен!
  ==== Статьи про конкретные программы (сервисы и т.д.) ====
@@ Строка 80: / Строка 145: @@
 > Если же нужна инструкция по специфичной настройке для какого-то случая - то в отдельную статью. Например: интеграция_ejabberd_с_active_directory
 >  --- [[user>Malamut]] //2012/05/12 13:49//
+=====Статьи в разделе "Совместимость"=====
+> Этот раздел вообще не трогаю; мне кажется, его стоит вынести в отдельные рекомендации конкретно раздела.  --- [[user>forekko]]
+В данном разделе создаются статьи для каждого устройства, в которых описываются особенности (или отсутствие) их использования вместе с Ubuntu. При написании статьи, воздержитесь, пожалуйста, от эмоциональной окраски текста, используйте технический язык.\\ Имя адреса страницы должно содержать производителя и модель описываемого устройства:
+<file>help.ubuntu.ru/совместимость/hp_pavilion_dv6_2055er</file>
+Ссылка на статью должна быть __обязательно__ добавлена в статью
+<file>help.ubuntu.ru/совместимость/производитель_устройства</file>
+> Так тэги же нужно использовать, а страницы производителей устройств сделать индексными просто, страницы без тэгов- удалять.
+>  --- [[user>Пупизоид]] //2012/05/16 14:15//
+====Шаблон статьи====
+<file>
+======Название устройства======
+В имени статьи указывается только модель устройства (Без производителя)
+Далее указывается:
+Совместимость с Ubuntu: нет проблем\решаемые проблемы\нерешаемые проблемы
+======Графика======
+Описываются проблемы (и их решения) с графикой
+======Звук======
+Описываются проблемы (и их решения) со звуком
+======Сеть======
+Описываются проблемы (и их решения) с сетевыми устройствами
+======Bluetooth======
+Описываются проблемы (и их решения) с функцией передачи файлов
+======Прочее оборудование=====
+Описываются проблемы (и их решения) с прочим оборудованием (кардридеры, клавиатуры и т.д.)
+======Ссылки======
+Ссылки на сторонние материалы по решению проблем.
+{{tag>имя_производителя}}
+</file>
+Примечания:
+) для "нет проблем\решаемые проблемы\нерешаемые проблемы" можно придумать картинки веселые, и в шаблоне привести все три, нужно будет удалить лишнее только.
+====== Неструктурированные наброски идей по мотивам правил википедии ======
+Статьи следует писать на литературном русском языке в [[wpru>Научный_стиль|научном стиле]] от третьего лица.
+Если на предмет статьи существует несколько различных взглядов, то в идеале их все необходимо изложить, или хотя бы добавить пометки про другие варианты.
+Соблюдайте удобную для читателя последовательность повествования и размещения служебных пометок в исходном тексте статьи.
+Последовательность изложения:
+В статьях следует повествовать:
+от общего к частному
+от простого к сложному
+в порядке важности, известности, достоверности

Новые правила для ресурса Сравнение версий

Различия