Керівництво програміста на програмне забезпечення та автоматизовану систему, техрайтконсалт
Якщо крім використання і настройки, програмне забезпечення надає можливість написання, редагування або використання програмного коду. Який документ необхідний в цьому випадку?
Призначення керівництва програміста
Керівництво програміста відноситься до експлуатаційно-технічної документації і потрібно в тих випадках, коли система тим чи іншим чином надає можливість написання, редагування або використання програмного коду.
Прикладами можуть служити:
- платформа або середовище для розробки ПО;
- ПО з відкритим кодом.
- призначення, структуру вхідних і вихідних даних програмних функцій;
- можливості по створенню програмного коду, особливості його інтерпретації та компіляції;
- синтаксичні особливості мови програмування;
- можливі правила і обмеження при роботі з програмним кодом;
- різні інструкції по роботі з програмою.
Список можливих тем цим не обмежується, все залежить від особливостей конкретної системи. Треба сказати, що керівництво програміста буває дуже корисно і для розробників системи, будучи довідником по поточній реалізації логіки роботи ПО.
Склад типового керівництва програміста
Відповідно до вимог ГОСТ керівництво програміста повинно містити наступні розділи:
- Призначення та умови застосування програми. де вказують область застосування ПО і технічні вимоги, необхідні для його роботи.
- Характеристика програми. де описують режим роботи програми, показники швидкості її роботи і інші важливі для використання характеристики.
- Звернення до програми. де вказують способи і параметри запуску програми;
- Вхідні і вихідні дані. де описують формат, спосіб організації та інші вимоги до вхідних і вихідних даних;
- Повідомлення. де призводять тексти повідомлень, що видаються програмою в різних ситуаціях і дії, які необхідно при цьому зробити.
Різні приклади, ілюстрації і таблиці доцільно приводити в додатках до документа.