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

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

18.10.2013

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


Дайте общую оценку примеру документа

Просите кандидатов приносить с собой на собеседование бумажный и электронный варианты примеров их работы. Не отказывайтесь от любых примеров, даже если они «недостаточно технические». Навыки, применяемые для создания документа, который называется, скажем, «Создание превосходного теста» те же, что и применяются для создания документа с заголовком «Настройка сети».

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

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

Вступительная часть

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

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

  • Пустая страница
  • Страница об охране авторского права
  • История предыдущих версий публикации

Несмотря на то, что это страница под номером ii, сам номер страницы, так же, как на титульной странице, не должен быть указан на этой странице. Если на левой странице находится содержание, рассматривайте это как серьёзный недостаток структуры.

Если информация об охране авторского права или история публикации не растягиваются на правую страницу, на странице справа должно (наконец-то!) быть содержание. Номер страницы (обычно iii, зависит от расположения содержания относительно титульной страницы) должен теперь появиться на странице, и должен быть на каждой странице – в верхнем или нижнем колонтитуле.

Переверните страницу. На левой странице должно быть либо продолжение содержания, либо, если продолжения нет, то страница должна быть пустой, за исключением верхнего и нижнего колонтитулов. Слов «Данная страница преднамеренно оставлена пустой» никогда не должно быть ни на одной из пустых страниц.

Правая страница должна содержать введение к документу. Оно может быть озаглавлено «О документе» или что-то подобное. Нумерация страниц ведётся римскими цифрами. Если введение предшествует содержанию, не считайте это ошибкой структуры.

Переверните страницу. Левая страница может быть продолжением введения, иначе – должна быть пустой страницей, за исключением колонтитулов.

Главы

На первой странице должна начинаться первая глава, хотя заголовок не обязательно должен сообщать об этом. То есть, если в заголовке нет «Глава 1», то это не будет ошибкой. Нумерация страниц с первой страницы первой главы начинается с 1. Далее нумерация страниц продолжается арабскими цифрами. Некоторые авторы перед номером страницы ставят номер главы (1-1, 1-2 и т.д.). В этом случае каждая новая глава начинается на странице 1 (2-1, 3-1 и т.д.). Тогда как с моей точки зрения такой метод нумерации препятствует лёгкости восприятия документа, то многие авторы считают это хорошей практикой; вы не должны считать этот метод ошибкой (Прим. пер. – в России, как и в большинстве стран, такой способ не используется).

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

Дополнительный материал

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

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

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

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

(продолжение следует)

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

Тэги: , , ,

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

Облако тегов