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

Но необходимо тщательно собраться.

У техписателя на момент начала исследования должно быть следующее:

  1. доступ к продукту (автоматизированной системе, веб-сайту, приложению, физическому изделию и т.д.);
  2. несколько листов бумаги (даже если это цифровой продукт, первые заметки лучше делать на бумаге);
  3. письменные принадлежности - ручки, карандаши, фломастеры, маркеры (для более эффективной работы с заметками);
  4. и конечно кружка вкусного горячего чая или ароматного кофе (выбрать по душе).

Итак, обычно в своих изыскательных работах технические писатели применяют два подхода:

  • инструментальный,
  • функциональный.

Инструментальный подход

Исследования при данном подходе идут от “инструмента”, то есть от самого продукта, его интерфейса. Иногда такой подход ещё называют “структурным”, отталкиваясь от структуры продукта и его составных частей.

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

Функциональный подход

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

Допустим, что документируется некая информационная система складского учёта.

В рамках этой системы автоматизируются следующие процессы:

  • оформление договора на хранение,
  • приемка товара на хранение,
  • отгрузка товара со склада и т.д.

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

Свободное плавание

Помимо перечисленных подходов существует ещё один. Но используется он крайне редко. Называется этот подход “свободное плавание”.

Как правило, начинается он с описания первых экранов продукта, а дальше “понеслась душа в рай”. Можно сказать, что это смесь двух предыдущих подходов. Но отсутствие системности не позволяет применять его сколь-либо серьёзно в исследованиях. Разве что просто для первого знакомства с продуктом.

Лично мне ближе всего функциональный подход.

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