11.8.Керівництво системного програміста. Вимоги до змісту і оформлення.

Посібник користувача

Нині часто використовують ще один експлуатаційний документ, в який частково входить керівництво системного програміста, програміста і оператора. Цей документ називають Посібником користувача. Поява такого документу стала наслідком широкого поширення персональних комп'ютерів, працюючи на яких користувачі поєднують у своєму обличчі трьох вказаних фахівців.

Складання документації для користувачів має свої особливості, пов'язані з тим, що користувач, як правило, не є професіоналом в області розробки програмного забезпечення. У книзі С. Дж. Гримм дані рекомендації по написанню подібної програмної документації :

• враховуйте інтереси користувачів - керівництво повинне містити усі інструкції, необхідні користувачеві;

• викладайте ясно, використовуйте короткі пропозиції;

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

• будьте точні і раціональні - довге і заплутане керівництво зазвичай ніхто не читає, наприклад, краще привести малюнок форми, чим довго її описувати.

Посібник користувача, як правило, містить наступні розділи:

• загальні відомості про програмний продукт;

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

• опис запуску;

• інструкції по роботі (чи опис призначеного для користувача інтерфейсу);

• повідомлення користувача.

Розділ Загальні відомості про програму зазвичай містить найменування програмного продукту, короткий опис його функцій, реалізованих методів і можливих сфер застосування.

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

У розділі Запуск, як правило, описані дії із запуску програмного продукту і повідомлень, які при цьому можуть бути отримані.

Розділ Інструкції по роботі зазвичай містить опис режимів роботи, форматів введення-виведення інформації і можливих налаштувань.

Розділ Повідомлення користувача повинен містити перелік можливих повідомлень, опис їх змісту і дій, які необхідно зробити по цих повідомленнях.

11.9.Керівництво програміста. Керівництво оператора. Опис мови.

Керівництво системного програміста

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

Керівництво системного програміста повинне містити наступні розділи:

• загальні відомості про програмний продукт;

• структура;

• налаштування;

• перевірка;

• додаткові можливості;

• повідомлення системного програміста.

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

У розділі Структура програми мають бути приведені відомості про структуру програми, її складові частини, про зв'язки між складовими частинами і про зв'язки з іншими програмами.

У розділі Налаштування програми має бути приведений опис дій з налаштування програми на умови практичного застосування.

У розділі Перевірка програми має бути приведений опис способів перевірки працездатності програми, наприклад контрольні приклади.

У розділі Додаткові можливості має бути приведений опис додаткових можливостей програми і способів доступу до них.

У розділі Повідомлення системного програміста мають бути вказані тексти повідомлень, що видаються в ході виконання налаштування і перевірки програми, а також в ході її виконання, опис їх змісту і дій, які необхідно зробити по цих повідомленнях.

Контрольні питання

Назвіть види програмних документів.

Як складається записка пояснення?

Яким чином складається посібник користувача?

Як складається керівництво системного адміністратора?

Література

121. Зелковиц М., Шоу А., Гэннон Дж. Принципы разработки программного обеспечения: Пер. с англ.— М.: Мир, 1982 — 368 с., ил.

122. Іващук В.В. Курс лекцій «Засоби мультимедіа в нових інформаційних технологіях» Національний університет харчових технологій.-К.: НУХТ, 2011. – 77 с.

123. Когутяк М.І., Дранчук М.М., Когуч Я.Р., Шавранський М.В., Лещій Р.М. Автоматизація неперервних технологічних процесів в нафтовій та газовій промисловості: Навчальний посібник.–Івано-Франківськ: Факел, 2006.–385с.

124. Конспект лекцій з дисципліни “Системи технологій” : к. т. н., доц. Фесенко М.С. Алчевськ ДонДТУ 2006, 70 стр.

125. Кухнюк Н.В., викладач Технічного коледжу. Інтерактивний комплекс. з дисципліни “Автоматизація технологічних процесів”. 2008, 227 ст.

126. Ларман Крэг. Применение UML и шаблонов проектирования. 2-е издание.: Пер. с англ. – М. Вильямс, 2004-624 с.:ил.

127. Проць, О.А. Данилюк, Т.Б. Лобур. Автоматизація неперервних технологічних процесів. Навчальний посібник для технічних спеціальностей вищих навчальних закладів. – Тернопіль: ТДТУ ім. І.Пулюя, 2008. – 239 с.

128. С.В.Шаповал, Н.Г.Морковська. Конспект лекцій з курсу „Системи технологій” Харків. ХНАМГ, 2005.- 70 с.

129. Microsoft Corporation Принципы проектирования и разработки программного обеспечения. Учебный курс MCSD/Пер. с англ. -2-е издание. Русская Редакция, 2002 – 736 стр., ил.

130. Гагарина Л. Г., Кокорева Е. В., Виснадул Б. Д. Технология разработки программного обеспечения: учебное пособие / под ред. Л. Г Гагариной. — М.: ИД «ФОРУМ»: ИНФРА-М, 2008. — 400 с.: ил. — (Высшее образование).

131. Галіцин В.К., Сидоренко Ю.Т., Потапенко С.Д. Технологія програмування і створення програмних продуктів: Навч. посіб. — К.: КНЕУ, 2009. — 372 с.

132. Гужва В. М. Інформаційні системи і технології на підприємствах: Навч. посібник. — К.: КНЕУ, 2001. — 400 c.