Tag/tag.png

Unsupported Version
This article applies to an unsupported version of Ubuntu. More info...

Tag/tag.png

Style Cleanup Required
This article does not follow the style standards in the Wiki Guide. More info...

Tag/tag.png

Candidate for Deletion
This article may not be appropriate for this wiki, and may be deleted. More info...

Содержание

В качестве wiki-движка используется программа MoinMoin. Эта страница содержит заметки о том, как публиковать документацию в wiki. Наша цель состоит в том, чтобы создать доступную, надёжную и централизованную документацию.

Создание страниц

Для создания нового руководства надо выполнить два простых шага:

  1. Поиск. Перед добавлением руководства в wiki, воспользуйтесь поиском по статьям с похожей темой. Если найденные документы недостаточно заполнены или устарели, обновите их ! Будет лучше, если множество статей со схожей темой вы объедините в одно подробное руководство.

  2. Создание страницы. Если руководств по заданной теме не найдено, создайте новую страницу.

    • Подумайте над названием - выбор точного имени очень важен для того, чтобы пользователь легко и быстро нашёл ваше руководство.
      1. Выберете наглядное имя, описывающее суть содержимого
      2. Избегайте слова "howto" в заголовке страницы (здесь всё howto !)
      3. Выберете имя с заглавными буквами (типа WikiName). Не используйте пробелы или подчеркивания в именах.

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

Стиль

Указания по стилю, используемом в документации

Форматирование

Справка по оформлению страниц

Основы

Например, страница может выглядеть так:

= Заголовок страницы =
== Подзаголовок ==
Этот текст показывает писание в wiki. Следующие пункты важны:
 * Прочитайте рекомендации по стилю оформления
 * Убедитесь, что вы не повторяете уже существующий материал в wiki
 * ask the Documentation Team to check the guide afterwards and apply the appropriate tags.

Следующий абзац - буквенный список:
 a. это ''первый'' пункт
 a. это ''второй'' пункт
 a. это ''третий'' пункт
{{{
это блок кода
} }} (пробела не должно быть в вашей версии)

За подробной справкой обращайтесь в HelpContents

Дополнительные возможности

Wiki имеет много дополнительных возможностей для писателя! Например:

Удаление и переименование

Удаление и переименование страниц в этой wiki запрещено, но если вам необходимо это сделать - сообщите в WikiTeam.

Коммуникация

Guidelines for ensuring that your work is communicated to others working on the wiki.

WikiGuideRu (last edited 2017-09-03 04:26:50 by ckimes)