Чат поддержки

Практикум
Привет! Это поддержка Практикума 👋 Если что-то не получается — постараемся помочь. Пишите в чат или выберите другой способ связи

пт, 2 декабряв 17:21

Мы уже начали заниматься вашим вопросом, ответим в ближайшее время

Практикум

Здравствуйте!

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

Если же у вас возникнут иные вопросы — обязательно пишите, будем рады помочь :)

17:24

Выбрать способ связи

Поменять когорту

Перейти в профиль

Выйти из профиля

Добавить аккаунт

Поддержка, обслуживание и оценка результатов

спринт Поддержка, обслуживание и оценка результатов

Рабочая документация

2/2

О чём этот спринт

Документирование по ГОСТ

План миграции

4/4

План миграции

План подготовки кадров

Обучение пользователей

Информация для пользователей

Постпроектная деятельность

1/1

Воркшоп и домашнее задание

2/2

Заключение

1/1

Пригласить друзей

Информация для пользователей

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

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

некоторые сценарии использования системы не рассматривались во время обучения;

пользователи по какой-то причине не проходили обучение или успели его забыть;

пользователи столкнулись с ошибкой при работе с системой;

пользователям понадобилась другая связанная с системой информация.

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

описание элементов интерфейса;

инструкции по использованию функций системы;

инструкции по устранению ошибок;

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

технические спецификации оборудования;

контакты службы поддержки;

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

Эта информация может быть представлена в бумажном или электронном виде.

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

Справочная система

Электронные документы составляют основу справочной системы (help system).

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

Если справочная система является частью программы, то такую систему называют встроенной (embedded help system). Команда разработки разрабатывает и передаёт её пользователям так же, как и любую другую часть системы.

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

Так выглядит встроенная справка macOS:

Если справочная система не является частью программы, то её называют автономной (standalone help system). Информацию для пользователей размещают отдельно от самой программы, потому что пользователь сможет обратиться к ней, даже если программа не работает.

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

Так выглядит автономная справка macOS:

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

Руководство пользователя — это ключевая часть справочной системы.

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

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

введение;

настройка и начало работы;

основные сведения;

приложения;

безопасность и конфиденциальность;

перезагрузка, обновление, сброс и восстановление;

эксплуатация и поддержка.

В России при разработке руководства пользователя часто основываются на требованиях:

Подраздела 6.4 «Руководство пользователя» ГОСТ Р 59795-2021 «Автоматизированные системы. Требования к содержанию документов».

ГОСТ 19.505-79 «Руководство оператора. Требования к содержанию и оформлению».

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

Требования к руководству пользователя (оператора)

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

Согласно ГОСТ 19 руководство оператора должно содержать следующие разделы:

назначение программы;

условия выполнения программы;

выполнение программы;

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

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

Выполнение программы — так размечается раздел

1.1 Регистрация — подраздел

1.1.1. Шаг 1. — пункт

1.1.2. Шаг 2. — пункт

Разберём подробно каждый раздел руководства.

Раздел 1. Назначение программы

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

В этом разделе необходимо ответить на вопросы:

для чего было разработано ПО?

какие возможности оно предоставляет пользователю?

Сервис онлайн-образования Яндекс Практикум использует для обучения программную платформу. Разберём разделы руководства пользователя на примере этой платформы.

Назначение программы для платформы Практикума можно описать следующим образом:

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

Платформа позволяет студенту:

изучать теоретический материал;

решать практические задания, в том числе писать программы;

выполнять проектную работу и получать комментарии к решению.

Раздел 2. Условия выполнения программы

В разделе «Условия выполнения программы» должны быть указаны условия, необходимые для выполнения программы — минимальный и (или) максимальный состав аппаратных и программных средств.

В этом разделе указывают необходимые для выполнения программы требования к оборудованию и другим программам.

Например, платформа Практикума не предъявляет особых требований к оборудованию. Для выполнения программной платформы достаточно иметь:

компьютер или ноутбук с Windows или macOS;

доступ в интернет.

Но для более сложных программ указывают, например, требования к процессору и памяти компьютера, к характеристикам компьютерного оборудования (мышь, клавиатура, джойстик), к операционным системам, веб-браузерам, СУБД и их версиям.

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

тип процессора – Intel® Xeon®;

количество процессоров – 2 шт;

частота процессоров – 2,66 ГГц;

тип оперативной памяти – DDR-III (1 066 МГц);

объём оперативной памяти – 8 Гб.

объём доступного дискового пространства – 300 Гб.

Минимальный состав программных средств для выполнения программы может включать следующие пункты:

операционная система Windows (версии 10 и выше) или macOS (версии Big Sur 11.0);

веб-браузер Google Chrome (версии 37 и выше) или Safari (версии 14.1.2 и выше);

Microsoft Office (версии 2013 и выше).

Раздел 3. Выполнение программы

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

Как правило, раздел «Выполнение программы» содержит множество подразделов. Каждый подраздел — это отдельная функция.

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

Регистрация

1.1 Перейдите на страницу регистрации.

1.2 Укажите имя и фамилию.

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

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

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

1.6 Введите символы с картинки.

1.7 Убедитесь, что отмечен пункт о том, что вы принимаете условия Пользовательского соглашения и даёте согласие на обработку персональных данных.

1.8 Нажмите кнопку Зарегистрироваться.

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

Например, для описания работы с уроками в руководстве используются экраны интерфейса:

Чтобы перейти к списку уроков темы, нажмите на её название. Появится всплывающее окно с кратким описанием темы и списком уроков.

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

Чтобы начать проходить урок, нажмите его название.

Раздел 4. Сообщения

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

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

Нет доступа к этой странице

Почему?

Вероятно, вы попытались попасть на страницу, к которой у вас нет доступа. Когда ошибка происходит на стороне вашего браузера (клиента), её код всегда начинается на 4.

Что делать?

Вернитесь назад или напишите нам, если считаете, что это ошибка.

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

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

Назначение программы

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

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

Условия выполнения программы

Минимальный и максимальный состав аппаратных и программных средств описывается в разделе «Условия выполнения программы»

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

Выполнение программы

Инструкции по использованию функций программы описывают в разделе «Выполнение программы».

Раздел, описывающий действия пользователя в случае ошибки

Сообщения

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

Начать заново

Инструкция по использованию АО

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

Разберём на примере АО «Капсулы». В каждом мини-отеле сети «Капсула» установлены капсулы для сна, которые можно арендовать на несколько часов, чтобы быстро восстановить силы. Капсула — это АО, предоставляющее физический пользовательский интерфейс — пульт для управления функциями капсулы.

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

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

выбор времени сеанса;

выбор световой программы;

настройка температуры;

выбор программы массажа;

выбор музыкальной программы;

настройка громкости музыки;

завершение сеанса.

Попробуйте составить инструкцию по использованию аппаратного обеспечения «Капсулы».

Перед вами часть раздела «Выполнение программы» руководства пользователя пульта Капсулы.

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

Запуск сеанса

Чтобы запустить __, на пульте управления капсулой нажмите «__».

Дождитесь полного включения капсулы. Капсула полностью включена и готова к работе тогда, когда на __ пульта отобразилось __ «Привет! Я — Капсула!».

Важно!
Если капсула не начала работать, обратитесь за помощью к сотруднику отеля.

Завершение сеанса

Чтобы завершить сеанс, на __ управления капсулой нажмите « __ ».

Дождитесь полного выключения капсулы. Капсула полностью выключена тогда, когда экран пульта стал чёрным.

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

Старт, сообщение, пульте, сеанс, экране, Стоп, Важно

Правильный ответ

сеанс, Старт, экране, сообщение, пульте, Стоп, Важно

сеанс, Старт, сообщение, экране, Стоп, пульте, Важно

экран, Важно, сеанс, Старт, сообщение, пульте, Стоп

Перед вами описание инструкции по использованию функции «Выбор музыкальной программы» руководства пользователя капсулы. Расставьте шаги в верном порядке.

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

Шаг 3

Подтверждение выбранной программы — последний шаг инструкции.

Чтобы выбрать музыкальную программу, на пульте управления капсулой нажмите на ♫.

Шаг 1

Этот шаг описывает начало выбора музыкальной программы.

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

Шаг 2

На этом шаге объясняется выбор одной из нескольких программ.

Начать заново

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

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

Шаг 4

Подтверждение времени сеанса — последний шаг инструкции.

Чтобы выбрать время сеанса, на пульте управления капсулой нажмите на 🕗. На экране пульта отобразится минимальное время сеанса: 5 минут.

Шаг 1

Этот шаг описывает первое действие, которое необходимо выполнить для выбора времени сеанса.

Чтобы уменьшить время сеанса нажмите на －. Каждое нажатие на уменьшит время сеанса так же на 5 минут.

Шаг 3

Поскольку минимальный шаг — 5 минут, уменьшить время можно только третьим шагом.

Чтобы увеличить время сеанса нажмите на ＋. Каждое нажатие на увеличит время сеанса на минимальный шаг в 5 минут.

Шаг 2

Это описание второго шага инструкции.

Начать заново

Подведём итоги

К информации для пользователей относят:

описание элементов интерфейса;

инструкции по использованию функций системы и устранению ошибок (руководство пользователя);

рекомендации по работе с системой;

технические спецификации оборудования;

контакты службы поддержки;

юридическую информацию.

Пользователи могут по запросу просматривать эту информацию в электронном виде в справочной системе.

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

Ключевой частью справочной системы является руководство пользователя. Руководство пользователя составляет системный аналитик, руководствуясь требованиями как ГОСТов, так и предприятия.

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

назначение программы;

условия выполнения программы;

выполнение программы;

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

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

К следующей теме

Курсы

Вводный модуль

Понимание профессии системного аналитика

Разработка требований

Проект 1. Спецификация требований ко второму релизу Chatty

SQL для аналитиков

Моделирование данных

Проект 2. Моделирование данных и работа с базой данных интернет-магазина «Накарабине»

Моделирование процессов

Пользовательские интерфейсы

Agile-практики

Проект 3. Бэклог приложения для сети клиник «Вита»

Трудоустройство

Архитектура системы

Программные интерфейсы

Проект 4

Реализация системы

Поддержка, обслуживание и оценка результатов

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

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

x