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

Различия

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

Ссылка на это сравнение

Предыдущая версия справа и слева Предыдущая версия
Следующая версия
Предыдущая версия
wiki:новые_правила [2012/05/16 14:41]
СперанскийСперанскийСперанскийDictum ac factum [Шаблон статьи про программу]
wiki:новые_правила [2014/07/13 04:59] (текущий)
quatro удалил подпись
Строка 2: Строка 2:
  
 <note important>​Это черновик! Если есть идеи - смело правьте эту страницу,​ но добавляйте информацию только с подписью (есть в инструментах)</​note>​ <note important>​Это черновик! Если есть идеи - смело правьте эту страницу,​ но добавляйте информацию только с подписью (есть в инструментах)</​note>​
-**Документация Ubuntu.ru** снискивает ​всё большую ​популярность ​как внутри круга почитателей Ubuntu, так и далеко за его пределами. В связи с этим, способствуя дальнейшему перспективному развитию ресурса,​ члены Сообщества принимают и обязуются соблюдать нижеследующие **Правила и рекомендации**:​+**Документация Ubuntu.ru** становится всё более популярной как внутри круга почитателей Ubuntu, так и далеко за его пределами. В связи с этим, способствуя дальнейшему перспективному развитию ресурса,​ члены Сообщества принимают и обязуются соблюдать нижеследующие **Правила и рекомендации**:​
  
 ===== Создание статьи ===== ===== Создание статьи =====
Строка 17: Строка 17:
 >> ​ --- [[user>​Пупизоид]] //​2012/​05/​15 13:18// >> ​ --- [[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 строк- мало, мне кажется > 10-15 строк- мало, мне кажется
 >  --- [[user>​Пупизоид]] //​2012/​05/​16 13:43// >  --- [[user>​Пупизоид]] //​2012/​05/​16 13:43//
Строка 29: Строка 29:
 >> Ну в картинках то ковардак будет, их там нужно систематизировать,​ потому что структура папок то видна. >> Ну в картинках то ковардак будет, их там нужно систематизировать,​ потому что структура папок то видна.
 >> ​ --- [[user>​Пупизоид]] //​2012/​05/​15 13:04// >> ​ --- [[user>​Пупизоид]] //​2012/​05/​15 13:04//
 +
 +> В названии статей не должно быть никаких слов, обозначающих действие. Как-то:​ установка,​ настройка и т.д. В качестве общего исключения могут выступать статьи,​ образованные в результате разделения одной очень большой статьи на части путём выделения самых больших разделов.
 +> --- [[user>​Malamut]] //​2012/​05/​22 14:10//
  
 Создавая новую страницу,​ внимательно отнеситесь не только к её наполнению,​ но и наименованию с заголовком - визитной карточке страницы Документации. Имя статьи - слово или словосочетание,​ отображаемое после имени раздела '​wiki/',​ например,​ '​wiki/​**правила**',​ где **правила** - имя статьи в системе Документации. [[#​Создание статьи|Имя статьи задаётся её автором]]. Заголовком статьи считается первый [[syntax#​Разбивка на разделы|заголовок 1-го уровня]],​ отображающийся в шапке материала и, кроме того, на других индексных страницах. \\ Создавая новую страницу,​ внимательно отнеситесь не только к её наполнению,​ но и наименованию с заголовком - визитной карточке страницы Документации. Имя статьи - слово или словосочетание,​ отображаемое после имени раздела '​wiki/',​ например,​ '​wiki/​**правила**',​ где **правила** - имя статьи в системе Документации. [[#​Создание статьи|Имя статьи задаётся её автором]]. Заголовком статьи считается первый [[syntax#​Разбивка на разделы|заголовок 1-го уровня]],​ отображающийся в шапке материала и, кроме того, на других индексных страницах. \\
Строка 39: Строка 42:
 <​file>​ <​file>​
 ======Имя статьи====== ======Имя статьи======
-В этом ​разделе приводится общая ​информация о последующем тексте, так сказать, художественная ​часть, приводятся ссылки в вики на использующиеся термины. +Тут необходимо изложить основную ​информацию о рассматриваемом ниже предмете и (или) вопросе. Первые ​абзацы статьи играют роль вступительной части, приводятся ссылки в вики на используемые ​термины. 
-======//​Произвольно//​====== +=====//​Произвольно//​===== 
-в силу неординарности построения статей,​ решения о создании определённых подзаголовков ложатся на плечи автора или редактора,​ если автором эта важная составляющая была упущена.+В силу неординарности построения статей,​ решения о создании определённых подзаголовков ложатся на плечи автора или редактора,​ если автором эта важная составляющая была упущена.
 ======Ссылки====== ======Ссылки======
 здесь можно указать сторонние источники,​ дополнительные материалы по теме, и, например,​ ссылку на тему обсуждения страницы на форуме. ​ здесь можно указать сторонние источники,​ дополнительные материалы по теме, и, например,​ ссылку на тему обсуждения страницы на форуме. ​
Строка 51: Строка 54:
   * //​Произвольно//​ - в силу неординарности построения статей,​ решения о создании определённых подзаголовков ложатся на плечи автора или редактора,​ если автором эта важная составляющая была упущена.   * //​Произвольно//​ - в силу неординарности построения статей,​ решения о создании определённых подзаголовков ложатся на плечи автора или редактора,​ если автором эта важная составляющая была упущена.
   * **См.также** - здесь можно указать сторонние источники,​ дополнительные материалы по теме, и, например,​ ссылку на тему обсуждения страницы на форуме.</​del>​   * **См.также** - здесь можно указать сторонние источники,​ дополнительные материалы по теме, и, например,​ ссылку на тему обсуждения страницы на форуме.</​del>​
 +
 +
 ===== Наполнение и содержание ===== ===== Наполнение и содержание =====
 Следует учитывать следующее:​ короткий,​ но максимально полный;​ содержательный,​ но без лишнего материал увеличивает шансы прочтения пользователем статьи до конца, и, возможно,​ решения своей проблемы. \\ Следует учитывать следующее:​ короткий,​ но максимально полный;​ содержательный,​ но без лишнего материал увеличивает шансы прочтения пользователем статьи до конца, и, возможно,​ решения своей проблемы. \\
Строка 56: Строка 61:
 Любой другой материал,​ уже изложенный в другой статье,​ заново пересказывать не стоит - лучше просто дать ссылку.\\ Любой другой материал,​ уже изложенный в другой статье,​ заново пересказывать не стоит - лучше просто дать ссылку.\\
 Если вы обнаружили в себе рвение и возможность описать что-то не совсем подходящее к редактируемой статье - подумайте,​ [[#​Минимальный объём и значимость|нужно ли это остальным]]?​ - и, если нужно - напишите отдельную,​ с подробным раскрытием вопроса. ​ Если вы обнаружили в себе рвение и возможность описать что-то не совсем подходящее к редактируемой статье - подумайте,​ [[#​Минимальный объём и значимость|нужно ли это остальным]]?​ - и, если нужно - напишите отдельную,​ с подробным раскрытием вопроса. ​
 +<note important>​Ни в коем случае не забывайте про [[wiki:​syntax#​ссылки]]! Чем больше в статье [[wiki:​syntax#​ссылки|ссылок]],​ приоритетно - на [[wiki:​syntax#​внутренние|внутренние ресурсы]],​ тем прочнее она входит в систему Документации,​ тем крепче и стабильнее наблюдается взаимосвязь между разнообразными материалами.</​note> ​
 Все статьи следует,​ по возможности,​ **[[#​Иллюстрации и снимки экрана|сопровождать наглядными иллюстрациями]]**. Все статьи следует,​ по возможности,​ **[[#​Иллюстрации и снимки экрана|сопровождать наглядными иллюстрациями]]**.
 <note important>​Формирование [[#​Структура статьи|верной структуры]],​ [[#​Оформление|оформления]],​ использование возможностей [[wiki:​syntax|синтаксиса]] и, конечно же, достойное [[#​Наполнение и содержание|содержание]] и соблюдение общепринятой [[terms/​стилистика_статей|стилистики статей]] определяют успех статьи.</​note>​ <note important>​Формирование [[#​Структура статьи|верной структуры]],​ [[#​Оформление|оформления]],​ использование возможностей [[wiki:​syntax|синтаксиса]] и, конечно же, достойное [[#​Наполнение и содержание|содержание]] и соблюдение общепринятой [[terms/​стилистика_статей|стилистики статей]] определяют успех статьи.</​note>​
  
 +> Всегда стоит помнить,​ что многие пользователи используют не самую последнюю версию Ubuntu. Особенно это замечание актуально для серверных версий. Поэтому если вы хотите обновить статью,​ заменив какие-то устаревшие части на актуальные для текущего релиза Ubuntu, то **всегда** оставляйте комментарии с информацией о том, как нужно поступать при использовании старых версий. Проще говоря:​ **никогда** не удаляйте полезную информацию из статьи,​ если она актуальна хоть для какой-нибудь версии Ubuntu. Вместо этого переносите её в отдельные разделы или заметки,​ с пометкой об области применимости.
 +>  --- [[user>​Malamut]] //​2012/​05/​24 10:43//
 ===== Иллюстрации и снимки экрана ===== ===== Иллюстрации и снимки экрана =====
  
 Все статьи следует сопровождать пояснительными снимками экрана либо иллюстрирующими изображениями((к иллюстрирующим изображениям можно отнести,​ к примеру,​ логотип программы с официального сайта)). \\ Все статьи следует сопровождать пояснительными снимками экрана либо иллюстрирующими изображениями((к иллюстрирующим изображениям можно отнести,​ к примеру,​ логотип программы с официального сайта)). \\
 +Элементы оформления статей (галочки,​ крестики,​ логотипы Ubuntu и т.д.) необходимо брать (и добавлять свои) в пространстве **wiki:​оформление:​**.
 >​Основные требования:​ все скриншоты должны быть сделаны при использовании стандартной темы рабочего стола Unity со стандартным набором иконок с одним из стандартных фонов, дабы не отвлекать читателя на изучение особенностей оформления. Он должен видеть то, что будет видеть на экране своего монитора. >​Основные требования:​ все скриншоты должны быть сделаны при использовании стандартной темы рабочего стола Unity со стандартным набором иконок с одним из стандартных фонов, дабы не отвлекать читателя на изучение особенностей оформления. Он должен видеть то, что будет видеть на экране своего монитора.
 > >
Строка 80: Строка 89:
  
 > --- [[user>​Пупизоид]] //​2012/​05/​16 13:52// > --- [[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//
 =====Статьи про программы===== =====Статьи про программы=====
 Имя страницы статьи про программу,​ сервис и т.д. должна соответствовать шаблону:​ Имя страницы статьи про программу,​ сервис и т.д. должна соответствовать шаблону:​
Строка 116: Строка 130:
 {{tag>​программы}} {{tag>​программы}}
 </​file>​ </​file>​
-При возникновении своего видения настройки программы необходимо создать дополнительный раздел "​Настройка(альтернативная)"​.+При возникновении своего видения настройки программы необходимо создать дополнительный раздел "​Настройка(альтернативная)"​.\\ 
 +Тэг ''​программы''​-- обязателен!
  ==== Статьи про конкретные программы (сервисы и т.д.) ====  ==== Статьи про конкретные программы (сервисы и т.д.) ====
  
Строка 131: Строка 146:
 >  --- [[user>​Malamut]] //​2012/​05/​12 13:49// >  --- [[user>​Malamut]] //​2012/​05/​12 13:49//
 =====Статьи в разделе "​Совместимость"​===== =====Статьи в разделе "​Совместимость"​=====
 +> Этот раздел вообще не трогаю;​ мне кажется,​ его стоит вынести в отдельные рекомендации конкретно раздела. ​ --- [[user>​forekko]]
 В данном разделе создаются статьи для каждого устройства,​ в которых описываются особенности (или отсутствие) их использования вместе с Ubuntu. При написании статьи,​ воздержитесь,​ пожалуйста,​ от эмоциональной окраски текста,​ используйте технический язык.\\ Имя адреса страницы должно содержать производителя и модель описываемого устройства:​ В данном разделе создаются статьи для каждого устройства,​ в которых описываются особенности (или отсутствие) их использования вместе с Ubuntu. При написании статьи,​ воздержитесь,​ пожалуйста,​ от эмоциональной окраски текста,​ используйте технический язык.\\ Имя адреса страницы должно содержать производителя и модель описываемого устройства:​
 <​file>​help.ubuntu.ru/​совместимость/​hp_pavilion_dv6_2055er</​file>​ <​file>​help.ubuntu.ru/​совместимость/​hp_pavilion_dv6_2055er</​file>​
Строка 160: Строка 176:
 Примечания:​ Примечания:​
 1) для "​нет проблем\решаемые проблемы\нерешаемые проблемы"​ можно придумать картинки веселые,​ и в шаблоне привести все три, нужно будет удалить лишнее только. 1) для "​нет проблем\решаемые проблемы\нерешаемые проблемы"​ можно придумать картинки веселые,​ и в шаблоне привести все три, нужно будет удалить лишнее только.
 +
 +
 +====== Неструктурированные наброски идей по мотивам правил википедии ======
 +
 +Статьи следует писать на литературном русском языке в [[wpru>​Научный_стиль|научном стиле]] от третьего лица.
 +
 +Если на предмет статьи существует несколько различных взглядов,​ то в идеале их все необходимо изложить,​ или хотя бы добавить пометки про другие варианты.
 +
 +Соблюдайте удобную для читателя последовательность повествования и размещения служебных пометок в исходном тексте статьи.
 +
 +Последовательность изложения: ​
 +
 +В статьях следует повествовать:​
 +от общего к частному
 +от простого к сложному
 +в порядке важности,​ известности,​ достоверности
 +