КомпанияУслугиОбучениеСервисы

Как мир устроен? Концепционный раздел руководства пользователя

Версия для печати

Михаил Острогорский, 2008

Говоря о руководстве пользователя, мы обычно представляем себе документ, тем или иным способом описывающий программный продукт. Часто спрашивают: как должен быть написан такой документ, «от задач» или «от интерфейса». Однозначного ответа на этот вопрос не существует. В зависимости от назначения и технических особенностей продукта разработчик документации может выбирать разные способы изложения материала: ставить во главу угла крупные пользовательские задачи, элементарные функции программы или элементы интерфейса пользователя. Гост велит нам изъясняться в терминах входных и выходных данных*. Можно представить себе и другие подходы. Каждый из них наверняка будет обладать своими преимуществами, которые могут оказаться сведены к нулю в отсутствие концепционного раздела.

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

Встречаются комические сюжеты**, построенные на том, что нецивилизованный персонаж, фантастическим образом попадает в современный город. Каково его положение? Жизнь, которую он видит, в своей основе ему знакома. Он окружен людьми, которые ходят, разговаривают, во что-то одеты, принимают пищу и т.п. Более того, он довольно быстро, преодолев первоначальное недоумение, осваивает отдельные предметы, скажем, с водопроводный кран или выключатель электрического освещения. При этом он совсем не понимает, как у нас организован социум, трактует все происходящее вокруг него с позиции собственного мира (эпохи, планеты, острова — в зависимости от фантазии авторов). Поэтому постоянно и сам попадает впросак, и всех остальных ставит в неловкое положение. В чем тут дело? Функционирование крана или выключателя очевидно и постигается простейшим (хотя подчас шокирующим) опытом. Правила поведения в обществе известны его членами, но постороннему в явном виде не доступны, их проявления разнообразны, обусловлены многочисленными контекстами, чужаку остается лишь догадываться, каковы они.

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

Когда в концепционный раздел необходим? Перечислим несколько типичных случаев.

  • Программный продукт предлагает собственную модель предметной области. Например, геоинформационная система представляет карту в виде набора слоев, в каждом из которых находятся объекты определенных типов: в одном слое реки, в другом населенные пункты, в третьем готовые нормы осадков и т.д. Прежде, чем учить пользователя создавать слои и вставлять в них объекты, необходимо обстоятельно объяснить, что такое слой, какие слои бывают, какие типы объектов предусмотрены в каждом из них, что кроме дополнительных сложностей послойная структура карты дает ему, пользователю. На круг получается весьма объемный материал. На сосредоточенный в нем понятийный аппарат будут опираться все описания всех содержательных пользовательских задач и функций программы. Излагать этот между делом, вводя понятия прямо там, где пользователю предлагается что-либо создать или отредактировать, в принципе можно, но результат, скорее всего, выйдет удручающий. Описания процедур будут перемежаться общими рассуждениями, текст запестреет перекрестными ссылками.
  • Программный продукт сам по себе формирует новую предметную область или специфическую часть более широкой предметной области. Скажем, в программном продукте, реализующем какую-нибудь авторскую методику финансового анализа, приходится сначала излагать саму методику и только потом рассказывать о порядке ввода данных, формирования отчетов и построения графиков. Описывая CRM-систему, можно подробно описать порядок заполнения карточки клиента, контакта или сделки, но если не объяснить пользователю, как именно ему предлагается взаимодействовать с клиентами, он просто не будет понимать, зачем и когда все это делать.
  • Программный продукт реализует сложный интерфейс, состоящий из функциональных блоков, не сводимых к общеизвестным элементам интерфейса. Это часто встречается в программных комплексах, предназначенных для автоматизации предприятий, электронного документооборота, всевозможных учетных и управленческих задач. Так, в «1С-Предприятии» существует специфичное для этой платформы понятие обработки, а в «ТБ-Корпорации» понятие картотеки. Даже универсальные понятия электронного документа, проводки или прав доступа в разных программных продуктах получают схожие, но все-таки не полностью совпадающие трактовки.

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

Как должен быть написан концепционный раздел? Вот несколько рекомендаций.

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

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

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

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

Одна из основных проблем, с которыми сталкивается технический писатель при составлении концепционного раздела, — зацикливания определений. Надо ли долго объяснять, чем они плохи? Если мы выразили B через A, то выражать A через B некорректно. На практике полностью избавиться от зацикливаний удается не всегда, более того, некоторые ученые-лингвисты утверждают, что они возникают закономерно***. Но все же чем зацикливаний меньше, тем лучше.

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

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

Относительно общего объема документации концепционный раздел, как правило, невелик. В то же время, удачный концепционный раздел сильно облегчает жизнь как техническому писателю, так и пользователю. Умение составлять концепционные разделы — один из признаков высокой квалификации технического писателя.

* Правда, ЕСПД не знает такого документа, как руководство пользователя.

** Например, «Пришельцы» с Жаном Рено в роли средневекового рыцаря, заброшенного в современную Францию, или «Человек ниоткуда», где Сергей Юрский играет дикаря, привезенного в Москву антропологом.

*** С. Шелов. Определение терминов и понятийная структура терминологии - Изд-во Санкт-Петербургского университета, 1998 - 236 с.

© «Философт», 2008–2017

+7 (499) 500-44-77

mail@philosoft.ru

SpyLOG