Документ "Керівництво користувача"
РД 50-34.698-90. Автоматизовані системи. Вимоги до змісту документів: <.>.
Застосування ГОСТ:
Справжні методичні вказівки поширюються на автоматизовані системи (АС), що використовуються в різних сферах діяльності (управління, дослідження, проектування і т. П.), Включаючи їх поєднання, і встановлюють вимоги до змісту документів, що розробляються при створенні АС.
Інструкція користувача
Застосування ГОСТ:
Документ містить розділи:
1. Введення;
2) призначення та умови застосування;
3) підготовка до роботи;
4) опис операцій;
5) аварійні ситуації;
6) рекомендації по освоєнню.
1. Введення
1.1 Область застосування
ПРИКЛАД ЗМІСТУ:
Наповнення цього розділу можна взяти з документа "Технічне завдання, п.п.2.1".
1.2 Короткий опис можливостей
ПРИКЛАД ЗМІСТУ:
Наповнення цього розділу можна взяти з документа "Опис автоматизуються функцій, п.п.2.".
1.3 Рівень підготовки користувача
1.4 Перелік експлуатаційної документації
ПРИКЛАД ЗМІСТУ:
Перелік експлуатаційних документів, з яким необхідно ознайомитися:
- АС Кадри. "Керівництво адміністратора";
- АС Кадри. "Інструкція користувача";
- т.д.
- ін .;
2 ПРИЗНАЧЕННЯ І УМОВИ ЗАСТОСУВАННЯ
Застосування ГОСТ:
У розділі "Призначення та умови застосування" вказують:
1) види діяльності, функції, для автоматизації призначенням: засіб автоматизації;
2) умови, при дотриманні (виконанні, настанні) яких забезпечується застосування засоби автоматизації відповідно до призначення (наприклад, вид ЕОМ і конфігурація технічних засобів, операційне середовище і загальносистемні програмні засоби, вхідна інформація, носії даних, база даних, вимоги до підготовки фахівців і т.п.).
2.1 Види діяльності, функції
ПРИКЛАД ЗМІСТУ:
АС Кадри призначена для автоматизації наступних видів діяльності:
Наповнення розділу можна взяти в документі "Опис автоматизуються функцій, розділ ЦІЛІ АС І автоматизуються функцій".
2.2 Програмні та апаратні вимоги до системи
ПРИКЛАД ЗМІСТУ:
Приклад вимог до програмного забезпечення наведено в документі "Пояснювальна записка, п.п.3.10".
Приклад вимог до апаратного забезпечення наведено в документі "Технічне завдання, п.п.4.3.5".
3 ПІДГОТОВКА ДО РОБОТИ
3.1 Склад дистрибутива
ПРИКЛАД ЗМІСТУ:
До складу дистрибутива АС Кадри входить:
- СУБД Oracle 10.2g;
- Додаток установки бази даних;
- Серверна частина Windows додатки АС Кадри;
- Клієнтська частина Windows додатки;
- т.д .;
- пр.
3.2 Запуск системи
ПРИКЛАД ЗМІСТУ:
Попередньо необхідно виконати установку системи. Інформацію про встановлення системи можна отримати в документі РД И3 (А) АС Кадри, який входить до складу проектної документації.
1. Для того, щоб запустити АС Кадри, відкрийте папку, в яку була встановлена програма, і запустіть файл kadry.exe.
2. У вікні, заповніть наступні поля в області вікна Загальні параметри:
- Логін - логін (логічне ім'я) користувача;
- Пароль - пароль для входу в систему;
3. т.д.
пр.
3.3 Перевірка працездатності системи
ПРИКЛАД ЗМІСТУ:
Програмне забезпечення працездатний, якщо в результаті дій користувача, викладених в п.п.3.2, на екрані монітора відобразилося головне вікно клієнтської програми без видачі користувачеві повідомлень про збої в роботі.
4 ОПИС ОПЕРАЦІЙ
Застосування ГОСТ:
У розділі "Опис операцій" вказують:
1) опис всіх виконуваних функцій, завдань, комплексів задач, процедур;
2) опис операцій технологічного процесу обробки даних, необхідних для виконання функцій, комплексів завдань (завдань), процедур.
Для кожної операції обробки даних вказують:
1) найменування;
2) умови, при дотриманні яких можливе виконання операції;
3) підготовчі дії;
4) основні дії в необхідній послідовності;
5) заключні дії;
6) ресурси, що витрачаються на операцію.
В принципі, допускається в межах розумного описувати операції без перерахування всіх наведених вище пунктів.
4.1 Найменування операції
4.2 Умови виконання операції
ПРИКЛАД ЗМІСТУ:
Додаток запущено, успішно функціонує, не виконує нікакх операцій, Блокирущие доступ до пунктів меню.
4.3 Підготовчі дії
ПРИКЛАД ЗМІСТУ:
Відсутні.
4.4 Основні дії
ПРИКЛАД ЗМІСТУ:
Відкрити пункт меню "Допомога", вибрати розділ "Довідка". У спливаючому вікні, що містить розділи з довідкою.
4.5 Заключні дії
ПРИКЛАД ЗМІСТУ:
Після завершення роботи з довідковою інформацією, закрити упливає вікно з довідкою.
4.6 Ресурси, що витрачаються на операцію
ПРИКЛАД ЗМІСТУ:
Відсутні.
5 АВАРІЙНІ СИТУАЦІЇ. ВІДНОВЛЕННЯ БАЗИ ДАНИХ
Застосування ГОСТ:
У розділі "Аварійні ситуації" вказують:
1) дії в разі недотримання умов виконання технологічного процесу, в тому числі при тривалих відмовах технічних засобів;
2) дії по відновленню програм і / або даних при відмові магнітних носіїв або виявленні помилок в даних;
3) дії у випадках виявлення несанкціонованого втручання в дані;
4) дії в інших аварійних ситуаціях
ПРИКЛАД ЗМІСТУ:
При збої в роботі апаратури відновлення нормальної роботи системи має здійснюватися після:
- перезавантаження операційної системи;
- запуску виконуваного файлу системи;
При помилках в роботі апаратних засобів (крім носіїв даних і програм) відновлення функції системи покладається на ОС.
При помилках, пов'язаних з програмним забезпеченням (ОС і драйвери пристроїв), відновлення працездатності покладається на ОС.
При невірних діях користувачів, невірних форматах або неприпустимих значеннях вхідних даних, система видає користувачеві відповідні повідомлення, після чого повертається в робочий стан, що передував невірної (неприпустимою) команді або некоректного вводу даних.
6 РЕКОМЕНДАЦІЇ ЩОДО ОСВОЄННЯ
Застосування ГОСТ:
У розділі "Рекомендації з освоєння" вказують рекомендації по освоєнню і експлуатації, включаючи опис контрольного прикладу, правила його запуску і виконання.
ПРИКЛАД ЗМІСТУ:
Для успішного освоєння програми АС Кадри необхідно мати навички роботи з ПК і вивчити наступне:
- Нормативно-правову базу з питань управління государсвенном кадрами;
- Розділ «Опис процесу діяльності» документа «Пояснювальна записка (Технічний проект)»;
- Розділ «Опис автоматизуються функцій» документа «Пояснювальна записка (Технічний проект)»;
- Справжнє «Керівництво користувача».
Контрольний приклад роботи з системою
Нижче розглянуто приклад роботи з системою, починаючи з її запуску і закінчуючи оформленням документів:
1. Запустіть систему.
2. т.д.
3. ін.