Стандартизація в області документування програмних засобів, директор інформаційної служби,

ARUBA INSTANT WI-FI: ПРОСТІ, ПОТУЖНІ, ДОСТУПНІ

що передавати користувачам, а що - службі супроводу? як управляти всім цим процесом?

Крім згаданих питань є й інші, наприклад, що має входити в саме завдання на програмування?

На ці та безліч інших запитань колись відповідали державні стандарти на програмну документацію - комплекс стандартів 19-й серії ГОСТ ЕСПД. Але вже тоді у програмістів була маса претензій до цих стандартів. Щось потрібно дублювати в документації багато разів (як, здавалося - невиправдано), а багато чого не було передбачено, як, наприклад, відображення специфіки документування програм, які працюють з інтегрованою базою даних.

Минуло багато років, програмування відбувається в середовищі абсолютно нових технологій, багато програмістів, працюючи в стилі drag-and-drop, можуть роками не бачити текст своїх програм. Це не означає, що зникла необхідність в їх документування. Більш того, питання про наявність хоч якоїсь системи, яка регламентує цю сторону створення програмних засобів (ПС), продовжують ставити постійно. Питають і про те, чи є обов'язкові для застосування стандарти (особливо гостро стоїть це питання, коли розробка виконується на замовлення державної організації або підприємства). Цікавляться і тим, де можна купити наявні стандарти.

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

Загальна характеристика стану

Основу вітчизняної нормативної бази в області документування ПС становить комплекс стандартів Єдиної системи програмної документації (ЕСПД). Основна і велика частина комплексу ЕСПД була розроблена в 70-е і 80-е роки. Зараз цей комплекс являє собою систему міждержавних стандартів країн СНД (ГОСТ), що діють на території Російської Федерації на основі міждержавної угоди по стандартизації.

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

Слід зазначити, що стандарти ЕСПД носять рекомендаційний характер. Втім, це відноситься і до всіх інших стандартів в області ПС. Справа в тому, що відповідно до Закону РФ «Про стандартизацію» ці стандарти стають обов'язковими на контрактній основі - тобто при посиланні на них у договорі на розробку (поставку) ПС.

Говорячи про стан ЕСПД в цілому, можна констатувати, що велика частина стандартів ЕСПД морально застаріла.

До числа основних недоліків ЕСПД можна віднести:

  • орієнтацію на єдину, «каскадну» модель життєвого циклу (ЖЦ) ПС;
  • відсутність чітких рекомендацій щодо документування характеристик якості ПС;
  • відсутність системної ув'язки з іншими діючими вітчизняними системами стандартів по ЖЦ і документування продукції в цілому, наприклад, СРПП і ЕСКД;
  • нечітко виражений підхід до документування ПС як товарної продукції;
  • відсутність рекомендацій по самодокументірованію ПС, наприклад, у вигляді екранних меню і засобів оперативної допомоги користувачеві ( «Хелп»);
  • відсутність рекомендацій за складом, змістом і оформленням перспективних документів на ПС, узгоджених з рекомендаціями міжнародних і регіональних стандартів.

Отже, ЕСПД потребує повного перегляду на основі стандарту ISO / IEC 12207-95 на процеси життєвого циклу ПС.

Проте, до перегляду всього комплексу, багато стандартів можуть з користю застосовуватися в практиці документування ПС. Ця позиція заснована на наступному:

При цьому стиль застосування стандартів може відповідати сучасному загальному стилю адаптації стандартів до специфіки проекту: замовник і керівник проекту вибирають доречне в проекті підмножина стандартів і ПД, доповнюють вибрані ПД потрібними розділами і виключають непотрібні, прив'язують створення цих документів до тієї схеми ЖЦ, яка використовується в проекті.

Треба сказати, що поряд з комплексом ЕСПД офіційна нормативна база РФ в області документування ПС і в суміжних областях включає ряд перспективних стандартів (вітчизняного, міждержавного і міжнародного рівнів), про склад і зміст яких далі буде сказано.

Короткий уявлення стандартів ЕСПД

З усіх 28 стандартів ЕСПД зупинимося тільки на тих, які можуть частіше використовуватися на практиці. Виділимо також ще один, істотно більш «свіжий», ніж інші, що відрізняється сумісністю з сучасними міжнародними стандартами.

Першим вкажемо стандарт, який можна використовувати при формуванні завдань на програмування.

ГОСТ 19.201-78 ЕСПД. Технічне завдання. Вимога до змісту та оформлення. Нагадаємо, що технічне завдання (ТЗ) містить сукупність вимог до ПС і може використовуватися як критерій перевірки та приймання розробленої програми. Тому досить повно складене (з урахуванням можливості внесення додаткових розділів) і прийняте замовником і розробником, ТЗ є одним з основоположних документів проекту ПС.

Наступний стандарт орієнтований на документування результуючого продукту розробки: ГОСТ 19.402-78 ЕСПД. Опис програми.

Зробимо два зауваження.

  1. Незважаючи на можливість застосування не всіх, а тільки окремих стандартів комплексу, використана в них термінологія, способи позначення та інші деталі можуть зажадати опори на такі загальні стандарти, як ГОСТ 19.101-77 ЕСПД. Види програм і програмних документів, і інші.
  2. Склад документа «Опис програми» в своїй змістовній частині може доповнюватися розділами і пунктами, почерпнутими з стандартів для інших описових документів і керівництв: ГОСТ 19.404-79 ЕСПД. Пояснювальна записка, ГОСТ 19.502-78 ЕСПД. Опис застосування, ГОСТ 19.503-79 ЕСПД. Керівництво системного програміста, ГОСТ 19.504-79 ЕСПД. Керівництво програміста, ГОСТ 19.505-79 ЕСПД. Керівництво оператора.

Є також група стандартів, що визначає вимоги до фіксації всього набору програм і ПД, які оформляються для передачі ПС. Вони (див. Врізку) породжують лаконічні документи облікового характеру і можуть бути корисні для впорядкування всього господарства програм і ПД (адже дуже часто потрібно просто навести елементарний порядок!). Є і стандарти, що визначають правила ведення документів в «господарстві» ПС.

Треба також виділити ГОСТ 19.301-79 ЕСПД. Програма і методика випробувань, який (в адаптованому вигляді) може використовуватися для розробки документів планування та проведення випробувальних робіт по оцінці готовності і якості ПС.

Нарешті, виділимо останній на поточний рік прийняття стандарт. Це ГОСТ 19.701-90 ЕСПД. Схеми алгоритмів, програм, даних і систем. Позначення умовні графічні та правила виконання. Він встановлює правила виконання схем, які використовуються для відображення різних видів завдань обробки даних і засобів їх вирішення і цілком відповідає стандарту ІСО 5807: 1985.

Про інших міждержавних стандартах

Поряд з ЕСПД на міждержавному рівні діють ще два стандарти, також відносяться до документування ПС і прийнятих не так давно, як велика частина ГОСТ ЕСПД.

ГОСТ 19781-90 Забезпечення систем обробки інформації програмне. Терміни та визначення. Розроблено на заміну ГОСТ 19781-83 і ГОСТ 19.004-80 і встановлює терміни та визначення понять в області програмного забезпечення (ПО) систем обробки даних (СОД), що застосовуються у всіх видах документації та літератури, що входять в сферу робіт по стандартизації або використовують результати цих робіт .

ГОСТ 28388-89 Системи обробки інформації. Документи на магнітних носіях даних. Порядок виконання та обігу. Поширюється не тільки на програмні, але і на конструкторські, технологічні та інші проектні документи, що виконуються на магнітних носіях.

Державні стандарти РФ (ГОСТ Р)

ДСТУ ISO 9127-94 Системи обробки інформації. Документація користувача і інформація на упаковці для споживчих програмних пакетів. Стандарт повністю відповідає міжнародному стандарту ІСО 9127: +1989. В контексті цього стандарту під споживчим програмним пакетом (ПП) розуміється «програмна продукція, спроектована і продається для виконання певних функцій; програма і відповідна їй документація, упаковані для продажу як єдине ціле ». Під документацією користувача розуміється документація, яка забезпечує кінцевого користувача інформацією з встановлення та експлуатації ПП. Під інформацією на упаковці розуміють інформацію, відтворену на зовнішній упаковці ПП. Її метою є надання потенційним покупцям первинних відомостей про ПП.

ДСТУ ISO / IEC 8631-94 Інформаційна технологія. Програмні конструктиви і умовні позначення для їх подання. Описує уявлення процедурних алгоритмів.

Як рухатися вперед

Як вже говорилося - поки немає кращого, можна отримувати користь і з тих стандартів ЕСПД, які прийняті ще близько 20 років тому. Але всім зрозуміло, що орієнтуватися треба на сучасні стандарти.

Практики використовують ще один шлях: самі переводять і використовують в своїх проектах сучасні стандарти на організацію ЖЦ ПС і їх документування. Але цей шлях страждає як мінімум тим недоліком, що різні переклади та адаптації стандартів, зроблені різними розробниками і замовниками, будуть відрізнятися масою деталей. Ці відмінності неминуче стосуються не тільки найменувань, а й їх змістовних визначень, що вводяться і використовуються в стандартах. Таким чином, на цьому шляху неминуче постійне виникнення плутанини, а це прямо протилежно цілям не тільки стандартів, але і будь-яких грамотних методичних документів.

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

Основні документи

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

ГОСТ 19.202-78 ЕСПД. Специфікація
ГОСТ 19.401-78 ЕСПД. текст програми
ГОСТ 19.403-79 ЕСПД. Відомість власників оригіналів
ГОСТ 19.501-78 ЕСПД. формуляр
ГОСТ 19.507-79 ЕСПД. Відомість експлуатаційних документів

Нові стандарти - керівнику:

ДСТУ ISO / IEC 9294-93. Інформаційна технологія. Керівництво з управління документуванням програмного забезпечення
ДСТУ ISO / IEC 9126-93. Інформаційна технологія. Оцінка програмної продукції. Характеристики якості і керівництва щодо їх застосування
ДСТУ ISO / IEC 9127-94. Системи обробки інформації. Документація користувача і інформація на упаковці для споживчих програмних пакетів

Довідкова інформація

ІПК «Видавництво стандартів». Територіальний відділ поширення НТД (магазин «Стандарти»), 17961, Москва, вул. Донська д. 8, тел. 236-50-34, 237-00-02, факс / тел. 236-34-48 (в частині ГОСТ і ГОСТ Р).

ВНИИКИ Держстандарту Росії (читальний зал). 103001, Москва, Гранатний пров. д. 4, тел. 290-50-94 (в частині міжнародних, зарубіжних стандартів і інших НТД).

Поділіться матеріалом з колегами і друзями