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

Но в большинстве случаев нестандартные решения приводят к потере текущих пользователей и увеличивают стоимость привлечения новых.

Почему после запуска проекта ожидания не равны результатам

Наблюдения за продвижением разных онлайн-сервисов показывают практически одинаковые результаты. Если после запуска сервиса опросить первых 100 пользователей, мы получим примерно такую картину:

• 40 человек не воспользуются сервисом, пока не ознакомятся с инструкциями, скриншотами и видеозаписями, созданными консультантами сервиса. За инструкциями они будут обращаться в техподдержку;
• 20 человек самостоятельно ознакомятся с инструкциями, изучат функции сервиса;
• еще 20 не поймут с чего начать работу и не воспользуются сервисом;
• только 10 пользователей выполнят все настройки правильно, не буду читать инструкции и обращаться в службу технической поддержки;
• оставшиеся 10 человек оценивали сервис, сравнивали его с конкурентами, пока не решили, будут ли его использовать.

Большинство пользователей не разбираются в функциях и навигации онлайн-сервиса; 40% пользователей не читают инструкции на сайте и обращаются за помощью к консультантам. Лишь 10% приступают к работе с сервисом без дополнительной помощи, поскольку имеют необходимый пользовательский опыт .

Как сделать сервис более понятным

Известный специалист в области юзабилити Якоб Нильсен утверждает, что “система должна быть равным образом приемлема для двух групп пользователей - новичков и опытных” (принцип гибкости и эффективности, одно из “10 эвристических правил дизайна пользовательского интерфейса”).

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

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

О чем спрашивают начинающие пользователи

Новые пользователи задают два вопроса:

1. С чего начать, чтобы пользоваться сервисом? (пользователь плохо понимает сервис) .
2. Как выполнить ту или иную задачу? (не понимает последовательности действий, сценария работы) .

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

• Пользователь не нашел инструкцию.
• Пользователь не разобрался в многостраничной документации.

Якоб Нильсен еще в 1995 году сформулировал правило: “лучше всего, если системой можно пользоваться, не читая документацию, но при необходимости нужно обеспечить справочную информацию, которая не должна быть слишком объёмной и должна предлагать список конкретных действий”.

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

В “10 эвристических правилах дизайна пользовательского интерфейса” Якоба Нильсена содержится целый ряд рекомендаций и правил по оформлению пользовательских инструкций.

Мы адаптировали эти советы.

Правила американского юзабилиста дополняет российский специалист, автор книги “Shareware: профессиональная разработка и продвижение программ” Станислав Жарков:

“При описании пути решения проблемы, как и при написании любой документации, нужно избегать составления слишком объемных текстов, т. к. пользователи будут просто пробегать их глазами, не вникая в смысл написанного, подобно тому, как человек, просматривающий газету, сначала останавливает взгляд на коротких заметках, пропуская большие материалы. Лучше всего составить что-то наподобие пошаговой инструкции, каждый шаг из которой составляет 1—2 предложения” (“Shareware: профессиональная разработка и продвижение программ”, СПб., 2001).

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

Создаем инструкции с помощью подсказок

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

Известные компании, например, Google и Facebook, помогают пользователям подсказками. Вы встречали их, если создавали на Facebook страницу компании или работали с текстом в Google Docs.

А это пример подсказки для пользователей Google Plus .

Краткие инструкции в подсказках обращают внимание пользователей на новые или дополнительные функции. Система автоматически показывает их новым пользователям в начале работы. Они отображаются лишь один раз, их можно закрыть (пропустить), либо перейти в справочный раздел ресурса и прочитать больше. Чтобы объяснить последовательность действий, разработчики сервисов объединяют такие подсказки в демо-туры. Подобные инструкции предлагают своим пользователям Google Plus и Youtube.

Чек-лист для разработки эффективной инструкции в форме подсказок

1. Опишите подсказками конкретные шаги пользователей.

2. Создайте обучающие туры для сценариев работы.

3. Объясните подсказками назначение сложных функций и специальных терминов.

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

5. Показывайте подсказки автоматически только один раз, при первом посещении пользователя.

6. Разрешите пользователю включать демо-туры в любой момент.

7. Оформите подсказки в едином для сервиса дизайне.

Инструменты для создания подсказок

Для создания одностраничных инструкций (для одного окна интерфейса) подходят готовые библиотеки кода Java Script: Intro.js и Bootstro.js . Для создания кросс-страничных подсказок подойдут сервисы Hintarea и Walkme.com .

Подсказки могут помочь тем, кто:

• установил новое мобильное приложение;
• воспользовался онлайн-сервисом (системой бронирования, доской объявлений);
• оформляет заказ в интернет-магазине;
• работает с бизнес-приложением (CMS, CRM).

Пример: подсказки для обучения пользователей CMS Wordpress

Представим типичную ситуацию. Веб-студия разработала сайт и передала его компании-владельцу. Наполнять сайт контентом будет менеджер компании. Скорее всего, он не имеет серьезного опыта работы с CMS (пусть в нашем примере это будет WordPress). Панель администрирования вызовет у него ряд вопросов:

• с чего начать работу;
• что означают названия и термины;
• где найти справочную информацию;

Веб-студия сильно упростит клиентам работу с сайтом, если заранее создаст для них подсказки в сложных местах.

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

Объясним пользователю, с чего начинать

Пользователь нажимает на кнопку “Добавить новую”. Появляется окно редактирования новой страницы и следующая подсказка.

Научим правильно заполнять формы

Обратим внимание на важные функции

Формируем понимание работы с контентом

Объясним специальные термины

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

Еще раз о пользе

Ценность подсказок для пользователей очевидна - те, кому раньше требовалась помощь, осваивают сервис или приложение самостоятельно.

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

Владельцы интернет-магазинов, разместившие подсказки, например, на странице оформления заказа, избавятся от части «брошеных корзин», повысят конверсию и доход магазина.

Изучайте реакцию пользователей на продукт, создавайте понятные и доступные инструкции. Это уменьшит потери потенциальных клиентов и сократит расходы на их привлечение.

Это перевод статьи, ранее опубликованной в американском журнале для интернет-предпринимателей sandhill.com.

Специально для онлайн-издания “ПроГрабли” материал значительно расширен, главным образом за счет включения информации по аспектам UX-дизайна при разработке веб-продукта.

Руководство пользователя

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

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

Типичное руководство пользователя содержит:

• Аннотацию, в которой приводится краткое изложение содержимого документа и его назначение
• Введение, содержащее ссылки на связанные документы и информацию о том, как лучше всего использовать данное руководство
• Страницу содержания
• Главы, описывающие, как использовать, по крайней мере, наиболее важные функции системы
• Глава, описывающая возможные проблемы и пути их решения
• Часто задаваемые вопросы и ответы на них
• Где ещё найти информацию по предмету, контактная информация
• Глоссарий и, в больших документах, предметный указатель

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

Стандарты

Структура и содержание документа Руководство пользователя автоматизированной системы регламентированы подразделом 3.4 документа РД 50-34.698-90. Структура и содержание документов Руководство оператора , Руководство программиста , Руководство системного программиста регламентированы ГОСТ 19.505-79 , ГОСТ 19.504-79 и ГОСТ 19.503-79 соответственно.

• Комплекс стандартов и руководящих документов на автоматизированные системы (ГОСТ 34)
  • РД 50-34.698-90 АВТОМАТИЗИРОВАННЫЕ СИСТЕМЫ. ТРЕБОВАНИЯ К СОДЕРЖАНИЮ ДОКУМЕНТОВ
• Единая система конструкторской документации (ЕСКД) определяет документ «Руководство по эксплуатации» и другие документы:
  • ГОСТ 2.601-2006 Эксплуатационные документы
  • ГОСТ 2.610-2006 Правила выполнения эксплуатационных документов
• Единая система программной документации (ЕСПД) определяет документы «Руководство оператора», «Руководство по техническому обслуживанию» и их структуру:
  • ГОСТ 19.101-77 Виды программ и программных документов
  • ГОСТ 19.105-78 Общие требования к программным документам
  • ГОСТ 19.505-79 Руководство оператора. Требования к содержанию и оформлению
  • ГОСТ 19.508-79 Руководство по техническому обслуживанию. Требования к содержанию и оформлению

См. также

Ссылки

• Руководство пользователя. Пример оформления по РД 50-34.698-90
• Бесплатные инструкции по эксплуатации бытовой электроники
• Сайт разработчиков технической документации (технических писателей)

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

Wikimedia Foundation . 2010 .

Смотреть что такое "Руководство пользователя" в других словарях:

Сущ., кол во синонимов: 4 инструкция (28) мануалка (5) паспорт (17) … Словарь синонимов

руководство пользователя - — [Е.С.Алексеев, А.А.Мячев. Англо русский толковый словарь по системотехнике ЭВМ. Москва 1993] Тематики информационные технологии в целом EN user guidemanual …

руководство пользователя

руководство пользователя по аккредитации и подаче заявок на Олимпийские игры - [Департамент лингвистических услуг Оргкомитета «Сочи 2014». Глоссарий терминов] Тематики спорт (службы Игр) EN accreditation and entries at the Olympic Games users guide … Справочник технического переводчика

Руководство: Руководство контроль поведения других людей (см. Власть). Руководство набор правил для осуществления или использования чего либо (см. Инструкция). См. также Руководство пользователя Организационное руководство Руководство … Википедия

руководство для пользователя - — [А.С.Гольдберг. Англо русский энергетический словарь. 2006 г.] Тематики энергетика в целом EN user directory … Справочник технического переводчика

руководство для пользователя - vartotojo instrukcija statusas T sritis automatika atitikmenys: angl. user guide; user manual vok. Benutzeranleitung, f; Benutzerhandbuch, n rus. руководство для пользователя, n pranc. notice de présentation, f … Automatikos terminų žodynas

РУКОВОДСТВО ПО РАЗРАБОТКЕ БЮДЖЕТА - BUDGET MANUALРазработка бюджета может быть упрощена до определенной степени, если у фирмы имеется руководство по разработке бюджета, к рое документирует процедуру разработки и определяет основные направления, к рым необходимо следовать на… … Энциклопедия банковского дела и финансов

справочник пользователя - vartotojo žinynas statusas T sritis automatika atitikmenys: angl. user directory; user guide; user manual vok. Bedienungsanleitung, f; Benutzerauskunftsdatei, f; Benutzerhandbuch, n rus. руководство пользователя, n; справочник пользователя, m… … Automatikos terminų žodynas

Р 50.1.041-2002: Информационные технологии. Руководство по проектированию профилей среды открытой системы (СОС) организации-пользователя - Терминология Р 50.1.041 2002: Информационные технологии. Руководство по проектированию профилей среды открытой системы (СОС) организации пользователя: 3.1.1 аккредитованная организация разработчик стандартов (accredited standards development… … Словарь-справочник терминов нормативно-технической документации

Книги

• Язык UML. Руководство пользователя , Буч Грэди. Эта книга будет изготовлена в соответствии с Вашим заказом по технологии Print-on-Demand. Унифицированный язык моделирования (Unified Modeling Language, UML) является графическим языком для…

Руководство пользователя - это справочник на бумажном или цифровом носителе (в формате PDF или XPS), в котором приводятся инструкции по эксплуатации чего-либо или описывается правильный порядок действий для совершения какого-нибудь процесса. Хотя когда человек слышит словосочетание "руководство пользователя", он обычно представляет руководство по использованию определенной программы, инструкции по эксплуатации есть у компьютерной и бытовой техники (телевизоры, стерео-системы, телефоны, мп3-плейеры, садовая техника и и т.д.). Хорошее руководство пользователя рассказывает об основных функциях прибора или программы и объясняет, как правильно ими пользоваться, при этом информация обычно хорошо структурирована. Эта статья расскажет, о чем важно помнить при создании и оформлении руководства пользователя.

Шаги

Часть 1

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

• Где человек будет пользоваться инструкцией по эксплуатации: дома, на работе, в машине, в интернете? Это определит не только содержание, но и стиль документации.
• Как человек будет пользоваться инструкцией? Если человеку потребуется лишь изредка заглядывать в руководство пользователя, значит, инструкция должна быть оформлена в сжатой форме. Если руководством будут пользоваться часто, особенно в самом начале, вам следует включить целый раздел о том, как начать пользоваться устройством или программным продуктом, и подробно описать все самые важные функции.
• Как много опыта должно быть у человека? Если ваш товар относительно новый или существенно отличается от похожих товаров, вам нужно будет включить информацию о том, чем этот товар отличается от аналогов, и предоставить пользователю подробные инструкции. Если товар связан с частыми проблемами (например, с большим количеством программ), опишите, что следует делать, когда проблема возникнет.

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

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

2. Часть 2

   Составные части руководства пользователя

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

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

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

      Если количество страниц превышает 10 штук, вам понадобится оглавление.

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

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

   4. Используйте изображения и схемы. Рисунки и скриншоты могут описать определенные процессы лучше, чем текст, особенно если речь идет от сложных процессах, где необходимо иметь визуальное подтверждение тому, что человек все делает верно. Графические изображения можно создать в специальных программах: в системах двух- и трехмерного черчения, в графических редакторах, в приложениях для обработки фотографий и т.д. Если необходимо сделать скриншоты, их можно получить с помощью штатных средств комьпютера и графической программы с возможностью сохранения скриншотов.

      • После того, как получите графическое изображение, сохраните его в сжатом формате. Вам также может потребоваться уменьшить размер рисунка, чтобы он помещался на страницу, но размер не должен быть слишком маленьким, так как иначе пользователь не сможет рассмотреть, как и что следует делать. Если потребуется, можно разбить изображение на несколько частей и описать каждую из них.
      • Если вы используете несколько изображений, они должны иметь одинаковый размер, пропорции и разрешение. Такие изображения будут более понятны и приятны читателю. При создании скриншотов убедитесь, что вы используете стандартную цветовую схему (для случаев, когда руководство печатается в цвете).
      • Хотя графические редакторы (например, Photoshop и Paint Shop Pro) удобны для создания скриншотов, лучше пользовать специальными программами (например, SnagIt), поскольку они позволяют сразу же быстро и легко отредактировать, сохранить и подписать все изображения.

      Часть 3

      Оформлении руководства по эксплуатации

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

         • У шрифтов с засечками есть небольшие черточки по краям линий. К таким шрифтам относятся Times New Roman, Baskerville и Book Antiqua. Такие шрифты подойдут большим объемам текста, напечатанного 10 или 12 размером и составляющего основу руководства пользователя.
         • Шрифты без засечек имеют простые линии без украшений. Это такие шрифты, как Arial, Calibri и Century Gothic. Шрифты без засечек лучше смотрятся в текстах, напечатанных 8 или 10 шрифтом в руководствах в формате PDF или web-документа. Чем крупнее шрифт, тем сложнее его читать без засечек. Однако эти шрифты можно использовать и для крупного текста - например, для набора заголовков. Шрифты без засечек подходят для набора цифр в таблицах и колонках.
         • Следует выбирать простые шрифты наподобие Arial или Times New Roman, хотя для цитат подойдет какой-нибудь более сложный шрифт. Если вы пишете руководство пользователя для фэнтезийной игры, можно выделить витиеватым шрифтом названия глав. Допускается также выделение цитат курсивом.
         • После того, как выберите шрифты, создайте тестовую страницу, чтобы убедиться, что эти шрифты сочетаются между собой на бумаге. Покажите эту страницу человеку, который одобряет макеты, прежде чем отдать руководство пользователя в печать.

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

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

      3. Подумайте над типом переплета. Если в вашем руководстве пользователя больше 4-х страниц, вам потребуется переплет. Документы для внутреннего пользования обычно скрепляют степлером в углу, но если вы будете вкладывать свое руководство в коробку с товаром, вам нужно будет подойти к этому вопросу более ответственно. Есть три типа переплета:

         • Скрепление скобой. Этот тип подходит для брошюр размерами 21x 27.5 см, 21x35 см или 11 x 27.5x42.5 см. Большинство недорогих инструкций по эксплуатации, которые состоят из 48 страниц и менее, переплетаются таким образом.
         • Переплет внакидку. Так переплетают большинство обычных инструкций по эксплуатации, не считая инструкций к автомобилям, хотя некоторые длинные руководства также переплетаются таким образом. (Paint Shop Pro изначально поставлялся именно с таким руководством пользователя.)
         • Переплет с проволочной спиралью. Таким способом переплетают руководства, которые используются в более суровых условиях, например, на улице, где скобы могут с легкостью сломаться или разойтись. В некоторых инструкциях по применению с таким переплетом также встречаются ламинированные страницы, которые не промокают и не пачкаются в грязи.

      4. Сверстайте документ. В большинстве текстовых редакторов и программ для публикации текста в интернете предусмотрена возможность верстки. По мере того, как вы будете набирать текст, он будет автоматически отображаться в выбранном шрифте. (Эта статья была изначально написана с помощью шаблона в Microsoft Word.) В этих программах также есть уже готовые шаблоны, которые вы можете изменить с учетом своих потребностей, вместо того, чтобы создавать шаблон с нуля.

         • В текстовых редакторах и программах для публикации текста в интернете также есть функция создания "стилей", сохранения шрифтов и задания размеров для оглавлений, колонтитулов и основного текста. Можно выбрать из уже существующих стилей ("Заголовок1", "Обычный", "Цитата") или создать свой собственный стиль и дать ему свое название. Рекомендуется называть стили по такой же системе, как это предусмотрено в программе. (Например, Microsoft Word создает такие названия, как "Заголовок1", "Заголовок2"; кроме того, есть еще подзаголовки.) Настраивайте программу заранее, чтобы вам не пришлось возвращаться к этому, когда вы будете заниматься написанием текста.
      • По возможности пользуйтесь кодами полей или текстовыми переменными. Можно изменять их значения (например, название продукта, название главы руководства пользователя) и помещать их в документ в места, где вы обычно стали бы набирать слова вручную. Когда вы сделаете предпросмотр документа или подготовите его к печати, нужный текст подставится в переменные. Если изменится название товара либо если вы решите изменить название главы, вам будет проще поменять текст, заменив значение переменной.

      Что вам понадобится

      • Текстовый редактор или программа для публикации текста в интернете
      • Графический редактор или программа для создания скриншотов

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

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

11.3. Руководство пользователя

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

Составление документации для пользователей имеет свои особенности, связанные с тем, что пользователь, как правило, не является профессионалом в области разработки программного обеспечения. В книге С. Дж. Гримм даны рекомендации по написанию подобной программной документации:

учитывайте интересы пользователей - руководство должно содержать все инструкции, необходимые пользователю;

излагайте ясно, используйте короткие предложения;

избегайте технического жаргона и узко специальной терминологии, если все же необходимо использовать некоторые термины, то их следует пояснить;

будьте точны и рациональны - длинные и запутанные руководства обычно никто не читает, например, лучше привести рисунок формы, чем долго ее описывать.

Руководство пользователя, как правило, содержит следующие разделы:

общие сведения о программном продукте;

описание установки;

описание запуска;

инструкции по работе (или описание пользовательского интерфейса);

сообщения пользователю.

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

Раздел Установка обычно содержит подробное описание действий по установке программного продукта и сообщений, которые при этом могут быть получены.

В разделе Запуск , как правило, описаны действия по запуску программного продукта и сообщений, которые при этом могут быть получены.

Раздел Инструкции по работе обычно содержит описание режимов работы, форматок вводавывода информации и возможных настроек.

Раздел Сообщения пользователю должен содержать перечень возможных сообщений, описание их содержания и действий, которые необходимо предпринять по этим сообщениям.

11.4. Руководство системного программиста

По ГОСТ 19.503-79 руководство системного программиста должно содержать всю информацию, необходимую для установки программного обеспечения, его настройки и проверки работоспособности. Кроме того, как указывалось выше, в него часто включают и описание необходимого обслуживания, которое раньше приводилось в руководстве оператора (ГОСТ 19.505-79) и/или руководстве по техническому обслуживанию (ГОСТ 19.508-79). В настоящее время данную схему используют для составления руководства системному администратору.

Руководство системного программиста должно содержать следующие разделы:

Общие сведения о программном продукте,

структура,

настройка,

проверка,

дополнительные возможности,

сообщения системному программисту.

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

В разделе Структура программы должны быть приведены сведения о структуре программы,

ее составных частях, о связях между составными частями и о связях с другими программами.

В разделе Настройка программы должно быть приведено описание действий по настройке программы на условия практического применения.

В разделе Проверка программы должно быть приведено описание способов проверки работоспособности программы, например контрольные примеры.

В разделе Дополнительные возможности должно быть приведено описание дополнительных возможностей программы и способов доступа к ним.

В разделе Сообщения системному программисту должны быть указаны тексты сообщений, выдаваемых в ходе выполнения настройки и проверки программы, а также в ходе ее выполнения, описание их содержания и действий, которые необходимо предпринять по этим сообщениям.

11.5. Основные правила оформления программной документации

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

Оформление текстового и графического материала. Текстовые документы оформляют на листах формата А4, причем графический матерная допускается представлять на листах формата A3. Поля на листе определяют в соответствии с общими требованиями: левое - не менее 30, правое - не менее 10, верхнее - не менее 15, а нижнее - не менее 20 мм. В текстовых редакторах для оформления записки параметры страницы заказывают в зависимости от устройства печати. При ручном оформлении документов параметры страницы выбирают из соображений удобства.

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

Наименование разделов пишут прописными буквами в середине строки. Расстояние между заголовками и текстом, а также между заголовками раздела и подразделов должно быть равно:

при выполнении документа машинописным способом - двум интервалам;

при выполнении рукописным способом - 10 мм;

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

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

при выполнении документа машинописным способом - трем интервалам;

при выполнении рукописным способом - не менее 15 мм;

при использовании текстовых редакторов - определяется возможностями редактора.

Разделы и подразделы нумеруются арабскими цифрами с точкой. Разделы должны иметь порядковые номера 1,2, и т. д. Номер подраздела включает номер раздела и порядковый номер подраздела, входящего в данный раздел, разделенные точкой. Например: 2.1, 3.5. Ссылки на пункты, разделы и подразделы указывают, используя порядковый номер раздела или пункта, на-

пример, «в разд. 4», «в п. 3.3.4».

Текст разделов печатают через 1,5-2 интервала. При использовании текстовых редакторов высота букв и цифр должна быть не менее 1,8 мм (шрифты №11-12).

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

Оформление рисунков, схем алгоритмов, таблиц и формул. В соответствии с ГОСТ 2.105-79 «Общие требования к текстовым документам» иллюстрации (графики, схемы, диаграммы) могут быть приведены как в основном тексте, так и в приложении. Все иллюстрации именуют рисунками. Все рисунки, таблицы и формулы нумеруют арабскими цифрами последовательно (сквозная нумерация) или в пределах раздела (относительная нумерация). В приложении - в пределах приложения.

Каждый рисунок должен иметь подрисуночную подпись - название, помещаемую под рисунком, например:

Рис.12. Форма окна основного меню

На все рисунки, таблицы и формулы в записке должны быть ссылки в виде: «(рис. 12)» или «форма окна основного меню приведена на рис. 12».

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

Если рисунок занимает более одной страницы, на всех страницах, кроме первой, проставляется номер рисунка и слово «Продолжение». Например:

Рис. 12. Продолжение

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

Схемы алгоритмов должны быть выполнены в соответствии со стандартом ЕСПД. Толщина сплошной линии при вычерчивании схем алгоритмов должна составлять от 0,6... 1 ,5 мм. Надписи на схемах должны быть выполнены чертежным шрифтом, высота букв и цифр должна быть не менее 3,5 мм.

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

Результаты тестов приведены в табл. 4.

Номер формулы ставится с правой стороны страницы в крутых скобках на уровне формулы. Например:

Оформление приложений. Каждое приложение должно начинаться с новой страницы с указанием в правом углу слова «ПРИЛОЖЕНИЕ» прописными буквами и иметь тематический заголовок. При наличии более одного приложения все они нумеруются арабскими цифрами: ПРИЛОЖЕНИЕ 1, ПРИЛОЖЕНИЕ 2 и т. д. Например:

ПРИЛОЖЕНИЕ 2

Титульный лист расчетно-пояснительной записки

Рисунки и таблицы, помещаемые в приложении, нумеруют арабскими цифрами в пределах каждого приложения с добавлением буквы «П». Например:

Рис. П. 12 - 12-й рисунок приложения; Рис. Ш.2 - 2-й рисунок 1 -го приложения.

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

Рис. П2.4. Файл menuran.pasпрограмма движения курсора основного меню.

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

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

11.6. Правила оформления расчетно-пояснительных записок при курсовом проектировании

При оформлении пояснительных записок следует придерживаться ГОСТ 7.32-91 (ИСО 596682) «Отчет по научно-исследовательской работе. Структура и правила оформления». В соответствии с этим стандартом текстовый документ подобного типа должен включать:

титульный лист,

реферат,

содержание,

введение,

основную часть,

заключение,

список использованных источников, в том числе литературы,

приложения.

Титульный лист оформляют в соответствии с ГОСТ 19.104-78 «Единая система программной документации. Основные надписи» (рис. 11.1).

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

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

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

В качестве примера рассмотрим оглавление пояснительной записки к проекту по курсу «Технология программирования».

Контрольные вопросы

1.Назовите основные виды программной документации. Охарактеризуйте каждый из них. В каких случаях их используют?

2.Что должно описываться в пояснительной записке? Кому она предназначена? Почему в пояснительной записке обычно описывают не только принятые решения, но и отвергнутые варианты?

3.На кого рассчитано руководство пользователя? Что оно должно содержать? В каких ситуациях вы читаете руководство пользователя? Вспомните прочитанные вами руководства пользователя. Что вам в них не понравилось?

ПРИЛОЖЕНИЕ

Система условных обозначений унифицированного языка моделирования (UML)

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

диаграммы вариантов использования или прецедентов(uses case diagrams) - показывают основные функции системы для каждого типа пользователей;

диаграммы классов (class diagrams): контекстные, описания интерфейсов и реализации - демонстрируют отношения классов между собой;

диаграммы деятельностей (activity diagrams) - представляют собой схему потоков управления для решения некоторой задачи по отдельным действиям, допускают наличие параллельных и/или альтернативных действий;

диаграммы взаимодействия (interaction diagrams) двух альтернативных типов:

а) диаграммы последовательности действий(sequence diagrams) - отображают упорядоченное по времени взаимодействие объектов в процессе выполнения варианта использования,

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

диаграммы состояний объекта (statechart diagrams) - показывают состояния объекта и условия переходов из одного состояния в другое;

диаграммы пакетов (package diagrams) - демонстрируют связи наборов классов, объединенных в пакеты, между собой;

диаграммы компонентов (component diagrams) - показывают, из каких программных компонентов состоит программное обеспечение и как эти компоненты связаны между собой;

диаграммы размещения (deployment diagrams) - позволяют связать программные и аппаратные компоненты системы.

Дополнениями к диаграммам служат формализованные и неформализованные текстовые описания, комментарии и словари.

При построении этих и других диаграмм используют унифицированную систему обозначений. Обозначения диаграмм прецедентов приведены в табл. П.1, диаграмм классов и пакетов - в табл. П.2, диаграмм взаимодействия - в табл. П3, диаграмм деятельностей и состояний объекта - в табл. П.4, диаграмм компонентов и размещения - в табл. П.5. При необходимости допускается использование обозначений одних диаграмм на других.

@ Журавлев Денис

Многие IT-компании, которые занимаются разработкой и сопровождением программного обеспечения и автоматизированных комплексов, сталкиваются с задачей создания пользовательской документации для своих продуктов в соответствии с требованиями ГОСТ.

Как правило, необходимость в наличии документации по ГОСТ возникает при сотрудничестве с государственными организациями, крупными производствами и компаниями, при заказной разработке программного обеспечения по тендерам и госзаказам или при необходимости добавить программный продукт в "Единый реестр российских программ для электронных вычислительных машин и баз данных (реестр отечественного ПО)".

Существует две серии (набора) стандартов, которые регламентируют набор создаваемых документов и правила их оформления при разработке автоматизированных систем, комплексов и программного обеспечения:

• ГОСТ 34 - Автоматизированные системы
• ГОСТ 19 - Единая система программной документации (ЕСПД)

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

Если говорить именно о документации для конечного пользователя системы, то из перечня описываемых в ГОСТ 34 документов нас интересует "Руководство пользователя". В ГОСТ 19 аналогичный по смыслу документ называется "Руководство оператора", но для программного обеспечения чаще используется именно первый вариант.

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

Для начинающего технического писателя или простого специалиста, которому неожиданно поручили подготовить руководство пользователя по ГОСТ, эта задача является серьезной проблемой.

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

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

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

Dr.Explain упрощает создание руководства пользователя по ГОСТ

Начиная с версии 5.5.1100 программа для создания пользовательской документации Dr.Explain предлагает функцию автоматизированной поддержки ГОСТ в проектах. Эта функция призвана значительно облегчить жизнь пользователям, перед которыми стоит задача создания руководства пользователя в соответствии с требованиями государственных стандартов.

В частности программа Dr.Explain контролирует и автоматизирует поддержку следующих требований стандартов:

• Наличие обязательных разделов документа “Руководство пользователя” [ГОСТ 34 РД 50-34.698-90]. Все разделы снабжаются пояснениями по их содержанию.
• Оформление титульных листов, аннотации и содержания [ГОСТ 19.105-78, 19.104-78].
• Параметры печатных страниц документа и расположение основных элементов на них [ГОСТ 19.106-78].
• Структуру и оформление колонтитулов [ГОСТ 19.106-78].
• Оформление текстовой части документа: стили шрифтов, абзацные отступы, межстрочные интервалы [ГОСТ 19.106-78].
• Формирование и оформление заголовков, разделов, перечислений (списков) [ГОСТ 19.106-78].

Управление функцией поддержки ГОСТ для проекта доступно в Настройках проекта в разделе Общие .

При включенном режиме поддержки ГОСТ для проекта соответствующие пользовательские настройки для печатаемых форматов RTF\DOC и PDF автоматически перекрываются программой, что гарантирует полное соответствие параметров выходных документов требованиям стандартов.

Для выходных форматов HTML и CHM будут использоваться пользовательские настройки вне зависимости от активности режима поддержки ГОСТ. Это снимает ограничение на свободную стилизацию этих форматов и позволяет, например, оформить онлайн-справку полностью в корпоративном или тематическом стиле.

Важно:

Важно: Функция поддержки ГОСТ доступна в Dr.Explain только в русскоязычной версии интерфейса. Язык интерфейса программы выбирается в меню Настройки\Выбор языка программы (Options\Application language ).

Создание нового руководства пользователя по ГОСТ

Для создания нового руководства пользователя по требованиям ГОСТ 34 в программе Dr.Explain можно использовать команды меню Файл \ Создать локальный проект - Руководство пользователя по ГОСТ 34 или Файл \ Создать общий проект на tiwri.com - Руководство пользователя по ГОСТ 34

или аналогичные кнопки на стартовом экране приложения.

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

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

Настройки оформления для печатных форматов RTF/DOC и PDF будут выставлены в соответствии с требованиям ГОСТ 19.

Приведение существующей пользовательской документации в соответствие с требованиями ГОСТ

Также программа Dr.Explain позволяет привести существующую пользовательскую документацию в соответствии с требованиями ГОСТ.

Важно: Перед включением режима поддержки ГОСТ для уже существующих в формате Dr.Explain проектов необходимо сделать резервную копию gui-файла проекта.

Если исходная документация еще не ведется в Dr.Explain, а хранится в других форматах, первым шагом необходимо выполнить импорт существующих документов в программу. Dr.Explain поддерживает импорт документов из ряда популярных форматов. Команды импорта доступны как на стартовом окне программы, так и в меню Файл .

Затем необходимо включить режим поддержки ГОСТ в свойствах проекта описанным ранее способом. Программа проверит структуру документа на наличие обязательных разделов и, если они отсутствуют, создаст их. Остальные существующие разделы, наличие которых не регламентировано ГОСТами, будут перенесены в скрытый от экспорта раздел “Старое дерево разделов ”.

Пользователь должен будет перенести содержимое этих разделов или разделы целиком методом drag-n-drop в основное дерево проекта и отредактировать их по необходимости.

Как и в первом случае настройки оформления для печатных форматов RTF/DOC и PDF будут выставлены в соответствии с требованиям ГОСТ 19.