Формування якісної технічної документації до програмного забезпечення

Abstract

На сьогоднішній день багато українських ІТ-компаній основну увагу приділяють саме розробці програмного забезпечення, але не супроводжують його якісною технічною документацією. Тому в роботі обґрунтована важливість формування документації до програмного забезпечення. Розглянуто визначення якості документації відповідно до моделей якості, які поділяються на базові та корпоративні. Визначено, що якість технічної документації до програмних систем визначається трьома аспектами: за інформаційним наповненням, представленням та поданням. Відповідно до стандарту ISO/IEC-9126, який містить чотири компоненти, розглянуто життєвий цикл документації, а також описано його характеристики і підхарактеристики, за якими можна проаналізувати й оцінити якість документації. Цей міжнародний стандарт застосовуються для про-рамного забезпечення, що є інформаційним продуктом. Водночас інформаційним продуктом можна вважати і документацію. Якість інформаційного продукту може бути оцінена шляхом вимірювання таких властивостей: внутрішніх, зовнішніх і якістю використання. Але варто зауважити, що не всі характеристики і підхарактеристики, що містять ці моделі якості, придатні саме до формування якісної документації. Тому для проведення аналізу вибрано такі характеристики: функціональна придатність (повнота, коректність) і якість у використанні (можливість визначення придатності інформації, упізнаваність, привабливість (враження)). Також наведені структури документів, поданих у стандарті ГОСТ 19.101-77, які є складовими компонентами програмної документації як виду технічної документації. Побудова якісної документації до програмного забезпечення вимагає здійснення постійного спостереження і проведення аналізу щодо її коректності та якості, а також формуванню сучасних вимог до її якості: щоб документація була зручною у використанні і максимально інформативною. Тому проблема побудови якісної технічної документації є нагальною та актуальною.

There is a problem that when creating software products, many companies pay attention to software development, rather than the formation of documentation. Therefore, the paper presents the importance of forming documentation for software. The concept of documentation quality in accordance with quality models, which are divided into basic and corporate, was considered. It was determined that the quality of the technical documentation for software systems is determined by three aspects: the content, presentation and representation. In accordance with the ISO/IEC-9126 standard, which consists of four components, life cycle documentation was presented, as well as its characteristics and sub-characteristics that can be used to analyze and evaluate the quality of documentation. This standard applies to software that is an information product. In turn, the information product can be considered as documentation. The quality of the infor-mation product can be assessed by measuring the following properties - internal, external properties, quality in use. But it should be noted that not all the characteristics and sub-characteristics that contain these quality models are applicable for the formation of useful-oriented documentation. Therefore, the following characteristics were chosen for the analysis: functional suitability (completeness and correctness) and quality in use (appropriateness recognizability, helpfulness, attractiveness). The structures of documents presented in the standard GOST 19.101-77, which are components of the program docu-mentation as a type of technical documentation, were also given. Building quality software documentation requires constant monitoring and analysis of its correctness and quality, as well as the formation of modern requirements for its quality, so that the documentation was convenient, accessible to use and as informative as possible. Therefore, the problem of building quality technical documentation is urgent and relevant for further research.