Всё для технического документирования
+7 (495) 001-00-42
Разработка технической документации
Курсы для технических писателей
Программное обеспечение

Как нанимать технического писателя (часть 4)

21.10.2013

01В очередной части статьи о том, как нанимать на работу технического писателя, речь идёт о более внимательном рассмотрении тестового документа.


Рассмотрите тестовый документ более внимательно

Теперь вернитесь к оглавлению и для примерно 20% пунктов проверьте, что заголовки записаны точно так же, как заголовки, на которые ссылаются, а также то, что они находятся на указанной странице. Другими словами, если в оглавлении написано, что вы найдёте заголовок «Бизнес-окружение» на пятой странице, откройте страницу 5 и проверьте. Так как все настольные издательские системы генерируют оглавления автоматически, любые отличия между заголовком в оглавлении и страницей, на которую он ссылается, говорит об оглавлении, которое модифицировалось вручную. Это серьёзный недостаток, показывающий, что будут обнаружены и другие серьёзные проблемы с документом. Если вы не сможете учить кандидата использованию текстовых редакторов, не нанимайте этого человека.

Пролистайте документ и просмотрите номера страниц. Они идут по порядку? Проверьте номер страницы на правых страницах. Они всегда должны быть нечётными. Любые проблемы с нумерацией страниц должны считаться серьёзными недостатками для разработки документа. Однако некоторые документы не имеют номера страницы на первой странице каждой главы. Это не должно восприниматься как ошибка.

Откройте любую главу, объём которой составляет три или более страниц. Первая страница главы должна отличаться по виду – «выглядеть и восприниматься» – от последующих двух страниц. Отличие может быть незначительным или весьма разительным. Т.к. существует множество способов достичь этого различия, вы не должны расценивать этот фактор как отрицательный, если только там вообще нет различий.

В любой главе, состоящей из трёх или более страниц, посмотрите верхние и нижние колонтитулы на двух страницах, идущих сразу за первой страницей главы. Существует только три допустимых расположения для каждого элемента в верхнем и нижнем колонтитулах – слева, по центру и справа. Расположение элементов в верхнем и нижнем колонтитулах на странице должно быть зеркальным относительно расположения элементов в верхнем и нижнем колонтитулах на титульнике. (Это правило не применяется к первой странице главы). Т.е. если на левой странице номер страницы находится в левом углу, то на правой странице он должен находиться в правом.

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

Теперь прочитайте часть документа. Его должно быть легко читать и воспринимать, даже если вы ничего не знаете о предмете. Вы должны понять его без необходимости сильно сконцентрироваться. Вас не должно запутать то, что вы читаете; также вас не должна вводить в уныние мысль о том, чтобы прочитать следующий абзац. Учтите, однако, что проблемы с продуктом создадут проблемы и с руководством пользователя. Т.е. если у вас проблема с пониманием чего-то в тестовом документе, спросите себя: «Это плохо написан документ или плохо разработанный продукт?»

В качестве иллюстрации: однажды я документировал графический интерфейс, в котором было две кнопки «Изменить»!

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

  • Сначала должно определяться, где совершается действие. Это называется «сориентировать пользователя».
  • Потом должно определяться, собственно, действие.

Т.е. фраза «Из меню «Таблица» выберите «Отображать сетку» — правильная, но «Выберите «Отображать сетку» в меню «Таблица» – нет. Конечно, необходимости ориентировать пользователя нет, если нет сомнений в том, где необходимо совершить действие.

(окончание следует)

Источник: Hiring a Technical Writer

Тэги: , , ,

< Вернуться к списку публикаций

Облако тегов