Перейти в режим автора

Правила и стиль изложения wiki-статей

Значительная часть материалов WebMoney Wiki состоит из статей двух категорий:
  • Описание объекта (термина, системы, сервиса, программы) и
  • Пошаговая инструкция - описание последовательности действий для выполнения определенной задачи или функции.

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

  • определение объекта (назначение подключаемой функции);
  • перечень основных функций (возможностей для пользователя);
  • условия использования объекта (функции), в том числе технические, финансовые и др. ограничения;
  • ссылки на расположение объекта (URL сервиса, адрес загрузки программы) или сайта подключаемой функции;
  • ссылки на более подробные и/или смежные статьи данной тематики.

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

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

  • "вы" на WebMoney Wiki пишется с маленькой буквы;
  • не "выберете", а "выберите" ("выберете" - это форма слова в будущем времени, например, "Если вы выберете...", а "выберите" - повелительное наклонение. В инструкциях используется как правило повелительное наклонение);
  • чем меньше притяжательных местоимений, тем лучше ("Для привязки вашей карты к вашему кошельку откройте в своем браузере..").

Для повышения удобочитаемости текста следует:

  • ставить где это уместно ссылки на термины и статьи WebMoney Wiki;
  • выделять объекты интерфейса (названия кнопок, пунктов меню) "кавычками и курсивом";
  • при перечислении трех и более элементов (например, при описании возможностей программы) использовать нумерованные и ненумерованные списки.

см. также
Как создать wiki-статью
Как отредактировать wiki-статью
Рекомендации по обработке иллюстраций