Документ «Руководство пользователя» относится к эксплуатационной документации. Основная функция руководства пользователя заключается в обеспечении пользователя необходимой информацией для самостоятельной работы с программным обеспечением.
Таким образом, «Руководство пользователя» должно отвечать на следующие вопросы: что это за программа, что она может, что необходимо для обеспечения ее корректного функционирования и что делать в случае отказа системы.
Руководящим стандартом для создания документа «Руководство пользователя» могут, является ГОСТ 19.505-79 «Руководство оператора. Требования к содержанию и оформлению». Ниже приведена структура документа согласно стандарту.
Можно выделить следующие основные разделы руководства пользователя:
Назначение программного обеспечения;
Условия применения программного обеспечения;
Подготовка программного обеспечения к работе;
Назначение программного обеспечения
Инструкция по использованию программного обеспечения
Инструкция по использованию программного обеспечения (или просто «Инструкция пользователю», или «Руководство для пользователя») — это выдержка из полной документации, предназначенная для эксплуатации программного обеспечения. Она представляет собой независимый документ, в котором описывается: что делает программное обеспечение и как им пользоваться. «Инструкция пользователю» должна содержать всю необходимую для пользователя информацию и должна быть ему понятна без дополнительных материалов (без обращения к другим спецификациям). Следовательно, необходимая для этой инструкции информация переписывается полностью из соответствующих спецификаций. Первая часть инструкции является описательной и должна содержать:
Вконтакте Программа для Скачивания Музыки ВК не Нужна! Инструкция
- • наименование программного обеспечения;
- • краткое описание программного обеспечения;
- • перечень выполняемых им функций;
- • краткую характеристику метода (или методов), его достоинство и недостатки;
- • полную библиографическую ссылку на полное описание метода;
- • описание входных и выходных данных.
Следует помнить, что пользователь по своей квалификации не является программистом и поэтому его работа с программным обеспечением описывается на понятном ему языке и достаточно подробно, а именно:
- • как запустить программное обеспечение;
- • как продолжить работу с программным обеспечением (описывается подробный интерактивный режим его работы с ПО);
- • подготовка и ввод исходных данных в программное обеспечение;
- • как реагировать на запросы программного обеспечения;
- • как вести работу в исключительных ситуациях;
- • как реагировать на ошибки;
- • как восстановить работу программного обеспечения в случае аварийного его завершения;
- • как получить требуемый результат;
- • как правильно закончить работу с программным обеспечением (запланированный программой выход).
Источник: bstudy.net
Как пользоваться блютуз автосканером ELM327? Как подключить/Считать ошибки/Список программ
Руководство пользователя – альтернатива этапу обучения на проекте внедрения 1С
Панова Екатерина Посмотреть все статьи >> Младший консультант по внедрению 1С франчайзинговой сети «ИнфоСофт».
Время прочтения — 9 мин.
Получить бесплатную консультацию
Одним из важных этапов на проекте внедрения 1С является обучение сотрудников новой программе. Этап становится довольно «болезненным», если заказчик не согласен на обучение. Тогда рассматривается альтернативный вариант – написать руководства пользователей.
В этой статье я поделюсь опытом написания инструкций на проекте внедрения 1С. Расскажу, как писать ПОНЯТНЫЕ руководства пользователей, и главное – как внедрить в компании регламент для сотрудников.
Руководство пользователя – это технический документ, который предназначен для оказания поддержки пользователям конкретной системы. В этом смысле используется и слово «мануал» (manual).
Рассмотрим основной алгоритм написания инструкций для пользователей программы 1С.
1. ОПРЕДЕЛЯЕМ ТЕМУ И ЦЕЛЕВУЮ АУДИТОРИЮ
Для чего мы пишем инструкцию? Самый важный вопрос, на который нужно ответить. Я выделила несколько основных вариантов:
- Инструкция для конкретного блока учета в программе, например, «Инструкция по блоку Продажи»,
- Инструкция для определенной должности сотрудника, например, «Инструкция для менеджера по оптовым продажам»,
- Инструкция по конкретной функции или процессу, например, «Инструкция по маркировке товаров».
Для кого мы пишем инструкцию? Необходимо понять для какого уровня пользователя нужно описать функционал программы – это новичок или опытный пользователь?
Эти вопросы стоит обсудить с заказчиком, ведь от них зависит основной принцип разработки инструкций.
2. ПРОДУМЫВАЕМ СТРУКТУРУ СОДЕРЖАНИЯ
Для выстраивания взаимосвязи разделов важно знать и понимать набор процессов и последовательность их действий. Разобраться в этом помогут:
- Концептуальный дизайн – основа для дальнейшей разработки проектных решений. Документ включает в себя модели бизнес-процессов, подлежащих автоматизации, проектирование ролей и полномочий, интеграционную модель, альбомы печатных и отчетных форм.
- Проектное решение – это документ, состоящий из методологического проектного решения, которое фиксирует функциональный объем проекта – определяет какие действия и сущности будут «покрыты» функционалом информационной системы, а также технического проектного решения, которое фиксирует объем, принципы и описание доработок конфигурации 1С и является основой для дальнейшей доработки – изменения типовых и создания новых объектов конфигурации 1С.
- Встречи с заказчиком.
Пример: блок учета – ценообразование, процессы – ведение информации о видах цен, сегментах партнеров, установка цен номенклатуры, использование обработок. Тогда структура содержания может выглядеть следующим образом:
Пример: пользователь – кладовщик ордерного склада, функции и их последовательность – приемка и отгрузка товаров, учет товарно-материальных ценностей в эксплуатации. Тогда структура содержания может выглядеть следующим образом:
Пример: процесс – реализация маркированных товаров. Менеджер по продажам создает реализацию товаров, выгружает данные на терминал сбора данных, затем кладовщик на складе считывает товары на терминал сбора данных и заносит их в 1С. Тогда структура содержания может выглядеть следующим образом:
3. ПИШЕМ ИНСТРУКЦИЮ
Перед аналитиком встала ответственная задача – написать инструкцию так, чтобы тебя поняли. Рассмотрим основные принципы написания мануалов.
Содержательность. Опишите функционал программы, расскажите в деталях обо всех этапах, нюансах и распространённых ошибках.
Подробная или не очень
Если инструкцией будет пользоваться новичок, то я рекомендую сделать следующее: поставьте себя на место пользователя, который первый раз в жизни видит программу. Такая инструкция будет очень подробная.
Если пользователь ранее работал в подобных программах, например, менеджер по продажам имеет опыт работы с программой 1С: Управление торговлей 11, тогда ему будет не сложно заполнить нормативно-справочную информацию и создать документы «Заказ клиента» и «Реализация товаров и услуг». Такая инструкция будет содержать меньше конкретики.
Не сокращайте слова, не используйте аббревиатуры и специальные термины, понятные только узкому кругу читателей. Текст должен быть понятен любому. Например, вместо «РТиУ» не поленитесь и пропишите полностью «документ Реализация товаров и услуг». Если без этого никак — оформите раздел «Глоссарий».
Если процессы повторяются или нужно сослаться на другой раздел, то необходимо проставить гиперссылки. Например: «Базовые соглашения с клиентом не используются в документах продаж, для этого необходимо создать индивидуальное соглашение ».
Если вы ссылаетесь на рисунок или таблицу, то воспользуйтесь механизмом «Перекрестная ссылка».
Структурированность. Разбавьте текст заголовками, абзацами и списками для удобного восприятия читателем.
Заголовки – это обязательно.
Позволяют «просканировать» ваш текст и остановиться сразу на нужной части. Но главное – не нарушать их иерархию.
Абзацы – это не так просто.
Есть универсальное правило: одна мысль – один абзац. Он не должен быть огромным, чтобы не перегружать информацией. Но и делать абзац из одного предложения тоже не стоит. Оптимальная длина – 5 строк.
Списки – это удобно и понятно.
Маркированный список – это обычный список перечисления с маркерами, точками. В перечне элементы не упорядочены между собой. От их перестановки местами смысл не поменяется.
Нумерованный список уместно использовать, если вы перечисляете этапы чего-то. Если элементы поменять местами, нарушится смысл.
Пример: чтобы оформить приобретение товаров через подотчётное лицо, необходимо выполнить следующие действия:
1) Перейдите в раздел Закупки – Документы закупки (все).
2) Нажмите кнопку «Создать – Приобретение товаров и услуг – Закупка через подотчетное лицо».
3) Укажите на вкладке «Основное» следующие данные:
- Организация,
- Поставщик,
- Контрагент,
- Договор,
- Склад.
4) Заполните вкладку «Товары».
5) Укажите на вкладке «Доставка» способ доставки.
6) Нажмите кнопку «Провести и закрыть».
Наглядность. Японское правило: «Одна картинка стоит тысячу слов».
Текст разбавляем скриншотами. Их желательно делать в той программе или интерфейсе, который есть у всех сотрудников, как правило – это тестовая рабочая база. Возможно редактирование скриншотов стрелками, выделением цветом нужных элементов и п орядка действий. Таким образом, пользователю будет проще понять, что необходимо сделать.
Подпишитесь на дайджест!
Подпишитесь на дайджест, и получайте ежемесячно подборку полезных статей.
Пример: чтобы установить значение цены номенклатуры в документе «Установка цен номенклатуры», необходимо выбрать подразделение, все влияющие и зависимые виды цен, затем перейти к установке:
Делюсь удобными и бесплатными инструментами для создания скриншотов:
- Lightshot. Скачать можно тут.
- Яндекс.Скриншот, входит в состав утилиты Яндекс.Диск. Посмотреть можно тут.
Важные фрагменты текста
Если читателю обязательно нужно обратить внимание на важный фрагмент текста, то перед описанием можно указать слова «Важно», «Обратите внимание» и сделать акцент на размер, шрифт и цвет текста.
Пример: Обратите внимание. Обычный менеджер не сможет отредактировать график оплаты в соглашении c клиентом. Для этого предусмотрена отдельная роль. Если данный функционал не доступен, то необходимо обратиться в ИТ-отдел.
Экспертность. Автор обязан хорошо разбираться в теме.
Если так вышло, что описываемый блок программы – новая тема для аналитика, тогда за основу типового функционала рекомендую взять инструкции с официального сайта 1С: ИТС.
Можно указать в тексте интерактивные ссылки на инструкции с сайта, чтобы не перегружать документ. Но если у пользователей нет выхода к интернету, то этот вариант не подходит.
Актуальность. Инструкцию придется периодически обновлять.
Если порядок действий, интерфейс программы, который вы описываете, меняется, то инструкцию нужно обновлять. Вопрос – кто должен это делать?
- Если изменение произошло во время написания инструкции, например, обновилась версия программы или был доработан функционал, тогда сделать это нужно автору мануала в оперативном режиме.
- Если инструкции приняты заказчиком или проект уже закончен, в этом случае за актуальность отвечает заказчик.
4. ПРОВЕРЯЕМ, ПРОВЕРЯЕМ И ЕЩЕ РАЗ ПРОВЕРЯЕМ
Чтобы написать грамотную пошаговую инструкцию, вы сами напрямую должны были с этим столкнуться и прийти к успешному результату. Поэтому, как только вы закончили – сядьте и проделайте последовательно все действия из документации. Лучше тестируйте под правами пользователя, так как это поможет выявить недочеты и устранить ошибки не только в тексте, но и в доработанном функционале.
Итак, мы написали руководство пользователя, проверили его и сдали заказчику. Следующий этап – внедрение инструкции для сотрудников на предприятии.
КАК ВНЕДРИТЬ ИНСТРУКЦИИ ДЛЯ СОТРУДНИКОВ
Ответственность за внедрение инструкций полностью лежит на стороне заказчика. Как добиться, чтобы сотрудники читали инструкции и выполняли предписания? Если в компании нет службы или сотрудника, который контролирует соблюдение регламентов, они не будут выполняться. Возможно, руководитель сумеете вдохновить сотрудников в самом начале, они будут действовать по инструкции, но после перестанут ими пользоваться.
Правило №1. Должностные папки
Что нужно сделать, чтобы инструкции работали? Для начала убедитесь, что они появились в должностных папках сотрудников. Эти папки могут быть как физическими, так и электронными.
Правило №2. Проверка знаний
Скорее всего сотрудники никогда не будут читать и разбираться в инструкциях, если вы не будете проверять знания. Единственный способ мотивировать их — предупредить, что служба ИТ-отдела проведет тестирование понимания мануала. Тогда необходимость прочесть регламент и разобраться в нем станет для сотрудников очевидной.
Правило №3. Контроль выполнения
Служба ИТ-отдела должна проверять, как на самом деле выполняются регламенты в компании. Понятно, что мы не можем тратить на это много времени и ресурсов. Здесь нужно здравомыслие: просто устраивайте проверки с определенной периодичностью.
ПОДЫТОЖИМ. Для того, чтобы написать качественную инструкцию нам нужно:
1. Определить тему и целевую аудиторию.
2. Продумать структуру содержания.
3. Написать инструкцию, соблюдая следующие критерии:
- Содержательность,
- Структурированность,
- Наглядность,
- Экспертность,
- Актуальность.
4. Проверить инструкцию под правами пользователя.
Чтобы правильно внедрить регламент, необходимо соблюдать три правила:
1. Регламент попал к сотрудникам, и вы в этом убедились.
2. Сотрудник его прочитал, понял и прошел проверку знаний.
3. Соблюдение регламента контролируется.
Источник: is1c.ru