Это старая версия документа.
Содержание
Заметки для редакторов руководства для новичков
Где и что редактируем
Всё редактирование должно происходить в специальной копии текущей версии руководства, которая находится по адресу http://help.ubuntu.ru/manual/next.
Для того, чтобы получить туда доступ, вы должны состоять в группе редакторов руководства. Вступить в эту группу можно, написав заявку администратору ресурса документации .
Как редактируем: стиль
Стиль статей должен быть максимально лёгким и неформальным, никакой технической тягомотины. При этом нужно чётко придерживаться правил и норм русского языка. Жаргон и различные сомнительные языковые конструкции категорически запрещены. Мы, конечно, не Толстые, но писать всё-же надо по-русски.
Повествование должно быть обезличенным1). Изначально руководство писалось в первом лице, потому что так было удобней единственному автору. Но это не есть хорошо.
Как редактируем: повествование
По сути руководство представляет из себя не набор статей, а связанный рассказ. Поэтому нужно внимательно следить за последовательностью повествования, чтобы создавалось впечатление единой линии действий, приводящей к конечному результату - освоению Ubuntu.
Например: в статье про настройку внешнего вида рассказано, как поменять фон рабочего стола, и показан скриншот с новым фоном. Дальше в руководстве везде используются скриншоты с этим же фоном. То же касается добавления иконок каких-либо приложений на лаунчер, добавление индикаторов и т.д.
То есть крайне важно следить за мелочами, создающими связность руководства, и превращающими его в наглядную пошаговую инструкцию.
Но при этом каждая отдельная статья должна описывать свою тему, чтобы всё же было нормальное и чёткое разделение на главы.
Скриншоты
Необходимые материалы и требования к описываемой среде