Процесс создания документа включает в себя такие этапы, как:
— сбор сведений;
— анализ;
— разработка;
— рецензирование.
— сбор сведений;
— анализ;
— разработка;
— рецензирование.
В этой статье я расскажу о первом этапе — сборе сведений. Поясню, почему он важен, какую информацию необходимо получить и кто может помочь в этом.
Главное назначение документа — помогать читателю решать необходимые ему задачи. Поэтому, прежде всего, необходимо выяснить:
- Целевую аудиторию.
- Задачи целевой аудитории.
Также нужно извлечь у заказчика все возможные ресурсы для работы над документом.
Целевая аудитория
Чтобы документ был полезным и востребованным, нужно учитывать потребности и способности его читателей.
Потребности читателей позволяют понять какие особенности и качества объекта необходимо описывать, то есть определяют содержание документа. Например, описанием программного продукта может являться:
— описание его преимуществ и возможностей с целью знакомства и продвижения (для менеджеров проектов);
— инструкцией по использованию (для пользователей продуктом);
— справочником структурных элементов кода (для программистов, поддерживающих работоспособность продукта) и др.
— описание его преимуществ и возможностей с целью знакомства и продвижения (для менеджеров проектов);
— инструкцией по использованию (для пользователей продуктом);
— справочником структурных элементов кода (для программистов, поддерживающих работоспособность продукта) и др.
Способности читателя помогают определиться со степенью детализации и контекстом описания. Например, читателями инструкции по заполнению таблиц расписаний могут быть как диспетчер автостанции поселка, так и администратор транспортного сайта. Знание целевой аудитории поможет понять, насколько подробно нужно освещать тот или иной аспект, и значительно сужает круг анализируемой в дальнейшем информации.
Задачи целевой аудитории
Задачи, которые стоят перед читателем, определяют состав документа и являются основой для создания его структуры. Документ должен исчерпывающе отвечать на вопросы, которые могут возникнуть при решении этих задач, но не должен содержать избыточную информацию.
Ресурсы для работы
Это источники информации для самостоятельного анализа, тестирования и изучения объекта описания. А именно:
- Существующее описание объекта (текстовые заметки, аудио- и видео-записи).
- Сам объект описания (интерфейс и доступ к нему или исходники программного продукта и среда для его отладки).
- Координаты коллег, которые могут помочь с информацией по объекту описания.
Все эти сведения можно получить только в диалоге с заказчиком — только он знает, какие проблемы хочет решить. После обсуждения с заказчиком необходимо провести самостоятельный анализ. Например, поставить себя на место читателя и обдумать его желания. Возникшие идеи нужно обязательно согласовать.
Диалог можно организовать в виде личной встречи, письменно или по телефону. К переговорам следует подготовиться — составить список нужных вопросов, настроиться на дружелюбную и продуктивную беседу.
В ходе диалога важно задавать только нужные на данный момент вопросы. Если заказчик углубляется в детали, нужно вежливо направить его в нужную сторону. Также очень важна эмоциональная составляющая. Предже чем начинать говорить о делах, полезно подружиться с заказчиком, например, поговорить о приятной погоде или рассказать короткую смешную историю про себя. От этого зависит эффективность вашей совместной работы в дальнейшем.
Заключение
Если вам удалось выяснить цели документа и получить все необходимые средства для дальнейшей работы, можно приступать ко второму этапу — анализу. О нем речь пойдет в следующей моей статье.