Заметки для редакторов руководства для новичков

Кому задавать вопросы и кто вообще крайний

В данный момент ответственным за руководство является его первоначальный автор, . Соответственно он осуществляет подготовку к публикации и следит за качеством содержания.

Где и что редактируем

Всё редактирование должно происходить в специальной копии текущей версии руководства, которая находится по адресу http://help.ubuntu.ru/manual/next.

Для того, чтобы получить туда доступ, вы должны состоять в группе редакторов руководства. Вступить в эту группу можно, написав заявку администратору ресурса документации .

Как редактируем: стиль

Стиль статей должен быть максимально лёгким и неформальным, никакой технической тягомотины. При этом нужно чётко придерживаться правил и норм русского языка. Жаргон и различные сомнительные языковые конструкции категорически запрещены. Мы, конечно, не Толстые, но писать всё-же надо по-русски.

Повествование должно быть обезличенным1). Изначально руководство писалось в первом лице, потому что так было удобней единственному автору. Но это не есть хорошо.

Как редактируем: повествование

По сути руководство представляет из себя не набор статей, а связанный рассказ. Поэтому нужно внимательно следить за последовательностью повествования, чтобы создавалось впечатление единой линии действий, приводящей к конечному результату - освоению Ubuntu.

Например: в статье про настройку внешнего вида рассказано, как поменять фон рабочего стола, и показан скриншот с новым фоном. Дальше в руководстве везде используются скриншоты с этим же фоном. То же касается добавления иконок каких-либо приложений на лаунчер, добавление индикаторов и т.д.

То есть крайне важно следить за мелочами, создающими связность руководства, и превращающими его в наглядную пошаговую инструкцию.

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

Скриншоты

Основное и самое важное требование к скриншотам: они должны быть сделаны в теме по-умолчанию со стандартными настройками внешнего вида. Никаких изменений шрифтов, цветов, курсоров и т.д. Отдельно хочется обратить внимание на то, что не должно быть никаких лишних значков на рабочем столе, никаких лишних апплетов и т.д. Чистая Ubuntu.

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

Скриншоты отдельных приложений должны быть без кусков фона рабочего стола и на белом фоне. Фон отлично виден под скруглёнными уголками рамки, поэтому перед тем, как сделать скриншот приложения, поменяйте фон рабочего стола на сплошную белую заливку и убедитесь, что углы приложения не попадают на какие-либо иконки.

Ubuntu умеет делать скриншоты отдельных окон, а так же скриншоты с задержкой. Всё это делается с помощью стандартной программы снятия скриншотов. Не забывайте про эти функции и активно ими пользуйтесь там, где это обоснованно.

Скриншот экрана загрузки можно снять, загрузив Ubuntu в VirtualBox. Скриншоты установки можно снимать штатными средствами, загрузив Ubuntu с LiveCD и начав установку. При этом не забудьте до перезагрузки сохранить все скриншоты на внешний носитель, иначе они пропадут!

Скриншоты LiveCD должны быть сняты в запущенной с LiveCD системе. Поверьте, она сильно отличается от уже установленной. Как минимум - переводами и именем пользователя в углу.

Для рисования различных пометок на скриншотах (например, стрелочек) используйте чистый красный цвет (#ff0000). Либо, если же красный совсем не подходит, дополнительным является чистый синий и, на самый крайний случай, чистый зелёный.

Всегда сохраняйте неотредактированные оригиналы скриншотов!. Они потребуются при создании PDF версии, без них же потребуется делать много ненужной работы.

Необходимые материалы и требования к описываемой среде

Руководство содержит множество различного рода неформальных вставок (сноски, элементы оформления и т.д.). Вы можете добавлять свои сноски и удалять существующие, если они больше неуместны. Однако просьба всё же сохранять общий стиль и общую атмосферу руководства.

В частности есть несколько требований к тому, что описывается и что изображено на скриншотах2).

Имя пользователя

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

Hostname

Имя компьютера должно быть malamut-desktop. Имя компьютера видно только на экране установки (совершенно не обязательно так называть свой компьютер, достаточно снять скриншот и затем задать то, которое вам нужно). И в терминале. Поэтому перед тем, как снимать скриншоты терминала, нужно изменить имя компьютера. Для этого выполните следующую команду:

export PS1='\[\e]0;\u@malamut-desktop: \w\a\]${debian_chroot:+($debian_chroot)}\u@malamut-desktop:\w\$ '

Потом просто нажмите Ctrl+L.

Обои

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

Значительные изменения

Считаете, что стоит какие-то статьи убрать, а что-то напротив, добавить? Очень возможно так и нужно поступить, однако перед этим стоит всё как следует обсудить с другими редакторами, дабы не делать ненужную работу, которая рискует не попасть в финальный вариант.

Эпилог: подводим итоги

В целом огромная просьба уделить как можно больше внимание мелочам: одинаковому стилю скриншотов, связности повествования и т.д. Мелочи оказывают огромное влияние на впечатление от руководства.

Кроме этого не стесняйтесь предлагать какие-либо улучшения. Руководство в данный момент отражает взгляды только одного человека, а они могут быть (и есть!) далеко не полными. По всем вопросам и со всеми предложениями обращайтесь к .

1)
Есть три основных типа повествования: в первом лице - «Я провёл исследования…», в первом лице множественном числе - «Мы провели исследования…», ну и наконец обезличенное - «Были проведены исследования…»
2)
Они обусловлены желанием основного автора, плюс, в конце концов, надо же что-то использовать, а как показали отзывы, выбранная тема с собачками весьма близка большинству.