Стандарти документування програмної складової ІТ

Методи документування серед поширених - це схемний метод, документування за прототипом, модельний метод і документування з використанням меню. За схемним методом схема документа подається як текст із метазмінними, а текст документа з’являється шляхом заміни метазмінних на їхні значення (слова речення або тексти). Щоб документувати за прототипом, за зразок документа береться його прототип. Документування з використанням меню здійснюється тільки при машинному документуванні. Перші три методи придатні для документування як об‘єктів так і процесів, а останній – для документування тільки процесів.

Модельний метод документування, відомий на теренах СРСР з видання 1975 р. книги Д.Уолш «Руководство по созданию документации для математического обеспечения», ґрунтується на дворівневій моделі документування програм. На першому рівні описується зміст створюваного документа, а на другому – наводиться опис вимог до документа з можливим коментарем щодо стилю і викладу вимог. Це сприяє розробці документів, орієнтованих на різновиди користувачів документації, серед яких у ISO/IEC TR 9294 фігурують:

- фахівці з предметної галузі та системні аналітики;

- розробники програмних засобів;

- фахівці з видавництва документації;

- фахівці з забезпечення якості;

- фахівці з супроводу програмних засобів;

- кінцеві користувачі або експлуатувальники програмних засобів.

Для цих різновидів користувачів у ISO/IEC 9127 введено, а у ISO/IEC 6592 уточнено, з огляду на окремі класи програмних засобів, три категорії інформації:

- обов’язкова чи суттєва, що має бути в документації на кожний програмний засіб;

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

- факультативна чи необов’язкова, що наводиться в документації на розсуд її розробника.

У СРСР модельний метод Д.Уолш було використано у 1977–78 рр. у комплексі стандартів «Єдина система програмної документації» (ЄСПД) див.табл.4.3. Згодом модельний метод був задіяний у комплексі ГОСТ «Система стандартов технической документации АСУ» та у комплексі стандартів і керівних документів на автоматизовані системи:

- технічне завдання (ГОСТ 24.201);

- техніко-економічне обґрунтування створення АСУ (ГОСТ 24.202);

- пояснювальна записка до проекту і загальний опис АСУ (ГОСТ 24.203);

- розрахунок економічної ефективності і формуляр системи (ГОСТ 24.203);

- опис постановки задачі (ГОСТ 24.204);

- опис забезпечення та організації інформаційної бази (ГОСТ 24.205);

- перелік вхідних і вихідних сигналів і даних (ГОСТ 24.205);

- опис технологічного процесу оброблення даних (ГОСТ 24.205);

- опис комплексу технічних засобів АСУ з проектною оцінкою надійності (ГОСТ 24.206);

- опис програмних засобів АСУ і контрольного прикладу (ГОСТ 24.207);

- опис організаційної структури АСУ (ГОСТ 24.208);

- посадова інструкція (ГОСТ 24.209).

Таблиця 4.3 - Перелік чинних стандартів з документування програм

Номер стандарту	Назва документу
ГОСТ 19.001-77	ЕСПД. Общие положения
ГОСТ 19.005-85	ЕСПД. Р-схемы алгоритмов и программ. Обозначения условные графические и правила выполнения
ГОСТ 19.101-77	ЕСПД. Виды программ и программных документов
ГОСТ 19.102-77	ЕСПД. Стадии разработок
ГОСТ 19.103-77	ЕСПД. Обозначения программ и программных документов
ГОСТ 19.104-78	ЕСПД. Основные надписи
ГОСТ 19.105-78	ЕСПД. Общие требования к программным документам
ГОСТ 19.106-78	ЕСПД. Требования к программным документам, выполненным печатным способом
ГОСТ 19.201-78	ЕСПД. Техническое задание. Требования к содержанию и оформлению
ГОСТ 19.202-78	ЕСПД. Спецификация. Требования к содержанию и оформлению
ГОСТ 19.301-79	ЕСПД. Программа и методика испытаний. Требования к содержанию и оформлению
ГОСТ 19.401-78	ЕСПД. Текст программы. Требования к содержанию и оформлению
ГОСТ 19.402-78	ЕСПД. Описание программы
ГОСТ 19.403-79	ЕСПД. Ведомость держателей подлинников
ГОСТ 19.404-79	ЕСПД. Пояснительная записка. Требования к содержанию и оформлению
ГОСТ 19.501-78	ЕСПД. Формуляр. Требования к содержанию и оформлению
ГОСТ 19.502-78	ЕСПД. Описание применения. Требования к содержанию и оформлению
ГОСТ 19.503-79	ЕСПД. Руководство системного программиста. Требования к содержанию и оформлению
ГОСТ 19.504-79	ЕСПД. Руководство программиста. Требования к содержанию и оформлению
ГОСТ 19.505-79	ЕСПД. Руководство оператора. Требования к содержанию и оформлению
ГОСТ 19.506-79	ЕСПД. Описание языка. Требования к содержанию и оформлению
ГОСТ 19.507-79	ЕСПД. Ведомость эксплуатационных документов
ГОСТ 19.508-79	ЕСПД. Руководство по техническому обслуживанию. Требования к содержанию и оформлению
ГОСТ 19.601-78	ЕСПД. Общие правила дублирования, учета и хранения
ГОСТ 19.602-78	ЕСПД. Правила дублирования, учета и хранения программных документов, выполненных печатным способом
ГОСТ 19.603-78	ЕСПД. Общие правила внесения изменений
ГОСТ 19.604-78	ЕСПД. Правила внесения изменений в программные документы, выполненные печатным способом
ГОСТ 19.701-90	ЕСПД. Схема алгоритмов, программ, данных и систем. Обозначения условные и правила выполнения
ГОСТ 24.201–79	Система технической документации на АСУ. Требование к содержанию документа «Техническое задание»
ГОСТ 24.202–80	«-«. Требование к содержанию документа «Технико-экономическое обоснование создания АСУ»
ГОСТ 24.203–80	«-«. Требование к содержанию общесистемных документов
ГОСТ 24.204–80	«-«. Требование к содержанию документа «Описание постановки задачи»
ГОСТ 24.205–80	«-«. Требования к содержанию документов по информационному обеспечению
ГОСТ 24.206–80	«-«. Требование к содержанию документов по техническому обеспечению
ГОСТ 24.207–80	«-«. Требование к содержанию документов по программному обеспечению
ГОСТ 24.208–80	«-«. Требования к содержанию документов на стадии «Ввод в эксплуатацию»
ГОСТ 24.209–80	«-«. Требования к содержанию документов по организационному обеспечению
ГОСТ 24.301–80	«-«. Общие требования к выполнению текстовых документов
ГОСТ 24.302–80	«-«. Общие требования к выполнению
ГОСТ 24.303–80	«-«. Обозначения условные графические технических средств
ГОСТ 24.401–80	«-«. Внесение изменений
ГОСТ 24.402–80	«-«. Учет, хранение и обращение
ГОСТ 34.201-89	ИТ. Комплекс стандартов на автоматизированные системы. Виды, комплектность и обозначение документов при создании автоматизированных систем
ГОСТ 34.602-89	«-«. Техническое задание на создание автоматизированной системы
РД 50-34.698-90	ИТ. Комплекс стандартов и руководящих документов на автоматизированные системы. Требования к содержанию документов

У ДСТУ з ІТ модельний метод Уолш застосовано у ДСТУ 2851 для журналу і протоколу випробувань та звіту про випробування програмного засобу. Проте у цьому стандарті та у перелічених комплексах ГОСТ дворівневі моделі документів не орієнтовані на окремі різновиди користувачів і/або класи програмних засобів, тому ці стандарти спричиняють значні труднощі використання моделей для документування програм.

У ISO/IEC 6592 викладено новий профільний метод документування програмних засобів. Профіль документування – таблиці одиниць інформації, що описують вміст документів на всіх етапах життєвого циклу програмного продукту. Профільний метод відрізняється від модельного орієнтацією на єдину модель всієї або більшої частини документації, що поступово створюється впродовж життєвого циклу програмного продукту. Якщо моделі Уолш – це лише набір моделей конкретних документів, то профіль документування регламентує порядок і процедуру створення документації, що здебільшого автоматично матеріалізується з різних специфікацій, які розробляються на всіх етапах життєвого циклу – від технічних умов у складі технічного завдання до настанови користувача і опису контрольних процедур тестування роботоздатності програмного засобу.

Стандартизація документування програм в Україні. На початок 2004 року в Україні чинні такі стандарти з документування програм та автоматизованих систем:

- комплекс ГОСТ «Єдина система програмної документації» (табл. 4.3);

- ГОСТ 34.201, ГОСТ 34.602 і РД 50-34.698, що належать до комплексу нормативних документів на автоматизовані системи;

- ГОСТ 24.301, ГОСТ 24.302, ГОСТ 24.303, ГОСТ 24.401 і ГОСТ 24.402, що належать до системи технічної документації АСУ;

- ДСТУ 2851 “Програмні засоби ЕОМ. Документування результатів випробувань”.

У комплексі ЄСПД немає вимог до документування більшості процесів життєвого циклу: замовлення, постачання, конфігураційне керування, забезпечення якості, верифікація і тестування, спільний перегляд, аудит. Проте ЄСПД в значній мірі покриває вимоги документування таких процесів життєвого циклу, як розробка, експлуатація і супровід, встановлюючи для програмних засобів:

- правила виконання та умовні графічні позначення схем алгоритмів і програм;

- види та позначення програм і програмних документів;

- загальні вимоги до програмних документів і виконання їх друкованим способом;

- вимоги до змісту і оформлення технічних завдань і програмних документів;

- правила дублювання, обліку та збереження програмних документів;

- правила внесення змін до програмних документів.

Чинні ГОСТ 34.201, ГОСТ 34.602, РД 50-34.698, ГОСТ 24.301, ГОСТ 24.302, ГОСТ 24.303, ГОСТ 24.401, ГОСТ 24.402 мають ті ж вади, що й ЄСПД, встановлюючи лише:

- види, комплектність і позначення документів на автоматизовані системи;

- вимоги до змісту та оформлення технічного завдання на автоматизовану систему;

- вимоги до змісту документів на автоматизовані системи (щодо організаційного, технічного, інформаційного, програмного, математичного забезпечення і загальносистемних рішень);

- вимоги до оформлення текстових документів;

- загальні вимоги до виконання схем;

- умовні графічні позначення технічних засобів;

- вимоги до внесення змін до документації на автоматизовані системи;

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

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

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

Друге покоління стандартів початку 70-х років можна охарактеризувати як змістовну стандартизацію розробки окремих документів з встановленням змістовних, а не формальних вимог до окремих документів. Тобто якість документів, створених за цими стандартами, вже не можна контролювати лише за зовнішніми формальними ознаками, необхідно детально вивчати семантику розглянутих у документі відомостей.

Третє покоління стандартів можна охарактеризувати як системну змістовну стандартизацію документування, коли вимоги до вмісту подано одразу до всієї документації зазвичай як сукупність одиниць інформації. Окремий документ – це підмножина цієї сукупності.

Стандарти ЄСПД, в яких викладені вимоги до вмісту документів, ГОСТ 34.602 і РД 50-34.698 можна віднести до стандартів другого покоління (змістовна стандартизація окремих документів). Зазначимо, що вимоги до вмісту документів у цих стандартах занадто загальні і здебільшого нечіткі, тому змістовна стандартизація перетворилася на умовну.

Стандарти ЄСПД, в яких викладені вимоги до оформлення, і ГОСТ 24.301, ГОСТ 24.302, ГОСТ 24.303 і ГОСТ 34.201 належать до стандартів першого покоління (формальна стандартизація). Вимоги до оформлення документів детальні, досить чіткі, але здебільшого надмірні. Загалом позитив змістовної стандартизації майже знищив негатив формальної стандартизації.

План стандартизації документування програмних засобів. Дійшовши висновку, що стан документування програм в Україні незадовільний, також констатуємо, що потребують нагальної розробки стандарти третього покоління із системного змістовного документування програм і вони мають ґрунтуватися на профільному методі. Тобто слід розробити комплекс ДСТУ, гармонізувавши його з ISO/IEC-стандартами у частині методів документування, вимог до позначень, структури і оформлення документів та вимог до вмісту документування (див. табл. 4.4).

Таблиця 4.4 – Перелік ISO/IEC-стандартів з документування програмних засобів

Номер	Українська назва ISO/IEC-стандарту
6592:2000	Керівні принципи з документування комп’ютерних прикладних систем
9127:1988	Документація користувача та супровідна документація для пакетів програмних засобів широкого вжитку
9294:1990	Настанова з управління документуванням програмних засобів (розроблено проект ДСТУ)
12182:1998	Категоризація програмних засобів
14598-3:2000	Оцінка програмного продукту. Частина 3: Процес для розробників
14598-4:1999	Оцінка програмного продукту. Частина 4: Процес для замовників
14598-5:1998	Оцінка програмного продукту. Частина 5: Процес для оцінювачів
14764:1999	Супровід програмних засобів
15910:1999	Процес розробки документації користувача програмного продукту
16326:1999	Настанова з використання ISO/IEC 12207 для керування проектом
15846:1998	Процеси життєвого циклу програмного продукту. Керування конфігурацією
15271:1998	Настанова щодо ISO/IEC 12207. Процеси життєвого циклу програмного продукту
5807:1985	Символіка у документації та позначення блок-схем для даних, програм, систем, схем програм, системних ресурсів

Дата добавления: 2015-11-26