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

Документація програмного забезпечення(англ. software documentation) - супроводжуючі документи до програмного забезпечення, які містять в собі інформацію, що описує загальні положення необхідні для ознайомлення перед тим як використовувати його за призначенням. Така документація дуже важлива і описує не тільки яким чином правильно використовувати поставлене програмне забезпечення, а й пояснює основні використані алгоритми. В залежності від складності кожного окремого програмного забезпечення, його специфіки, а також ліцензії під якою воно створене - документація може варіюватися за обсягом і за змістом.

Основні компоненти

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

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

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

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

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

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

пояснювальна записка - обґрунтування прийнятих і застосованих технічних і техніко-економічних рішень, схеми та опис алгоритмів, загальний опис роботи програмного виробу;

На сьогодні існує цілий комплекс стандартів, які регламентують різні аспекти життєвого циклу ПЗ. До їх розробки були залучені такі міжнародні організації, як IEEE (Institute of Electrical and Electronic Engineers, Інститут інженерів з електротехніки та електроніки), ISO (International Standards Organization, Міжнародна організація зі стандартизації), EIA (Electronic Industry Association, Асоціація електронної промисловості), IEC (International Electrotechnical Commission, Міжнародна комісія з електротехніки), а також деякі національні дослідні інститути (ANSI, American National Standards Institute, Американський національний інститут стандартів; SEI, (Software Engineering Institute, Інститут програмної інженерії).

Завдання на практичну роботу:

Використовуючи код програми із Лабораторної роботи 11 дисципліни "Бекенд-розробка мовою PHP, підготуйте текстовий опис: