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

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

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

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

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

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

     3. Выберете имя с некоторыми заглавными буквами (типа WikiName). Не используйте пробелы или подчеркивания в именах.

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

Стиль

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

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

Помощь в оформлении страниц

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

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

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

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