Due to the rapid development of various software products, applications and information systems developed for government and commercial sectors as well as for common users there is the need to write a large amount of technical documentation describing the created product from various perspectives. The reasons for such documentation-«internal» and «external» ones are presented in this paper. The types of documentation: requirements documentation (defines the expectations for the software, including functional requirements, hardware requirements, compatibility and limitations); architecture documentation (defines the high-level architecture of the system: the components, their functions and the data and control flow); technical documentation (written for technical audience, describing the code, algorithms and interface); user manuals (there are several types of user documentation: tutorial, how-to guide and reference guide); marketing documentation are described. Documentation standards (free and paid) are given as well.
Today, there is a rapid development of the field of information technologies, which consists of the production of information technologies and related information, which must be written in the form of documentation. Formation of documentation that will contain not only the opinion of the manufacturer, but also the consumer becomes an important task. Because in the first of all, the software is primarily user-oriented. Developers usually provide a description of the software on official sites or in data repositories. While consumers post information in virtual communities, which are rapidly gaining popularity among the population. As a result, the author developed the system architecture for the formation of software documentation based on user experience, the source of which will be virtual communities. The architecture is presented in the form of a multi-agent system, which consists of the set of interacting agents. Agents are autonomous and interactive software systems that solve certain separate tasks, activate themselves and can interact with other agents and the environment in which they function at different points in time. After studying the methods of data integration from virtual communities, the method of data consolidation was chosen. For the correct interaction of agents, each other, a consolidated data repository is used, which receives data from various virtual communities and transfers it to documentation. The system architecture includes the following agents: data collection (from various virtual communities and their transfer to the consolidated data repository); verification of information content of posts (which were obtained as a result of the work of the previous agent) for reliability and adequacy, presence of unwanted content, elimination of duplication of data; structuring community posts according to existing documentation parts; assessment of the quality of the generated documentation according to the characteristics of the ISO/IEC 25010 standard.
На сьогоднішній день багато українських ІТ-компаній основну увагу приділяють саме розробці програмного забезпечення, але не супроводжують його якісною технічною документацією. Тому в роботі обґрунтована важливість формування документації до програмного забезпечення. Розглянуто визначення якості документації відповідно до моделей якості, які поділяються на базові та корпоративні. Визначено, що якість технічної документації до програмних систем визначається трьома аспектами: за інформаційним наповненням, представленням та поданням. Відповідно до стандарту ISO/IEC-9126, який містить чотири компоненти, розглянуто життєвий цикл документації, а також описано його характеристики і підхарактеристики, за якими можна проаналізувати й оцінити якість документації. Цей міжнародний стандарт застосовуються для програмного забезпечення, що є інформаційним продуктом. Водночас інформаційним продуктом можна вважати і документацію. Якість інформаційного продукту може бути оцінена шляхом вимірювання таких властивостей: внутрішніх, зовнішніх і якістю використання. Але варто зауважити, що не всі характеристики і підхарактеристики, що містять ці моделі якості, придатні саме до формування якісної документації. Тому для проведення аналізу вибрано такі характеристики: функціональна придатність (повнота, коректність) і якість у використанні (можливість визначення придатності інформації, упізнаваність, привабливість (враження)). Також наведені структури документів, поданих у стандарті ГОСТ 19.101-77, які є складовими компонентами програмної документації як виду технічної документації. Побудова якісної документації до програмного забезпечення вимагає здійснення постійного спостереження і проведення аналізу щодо її коректності та якості, а також формуванню сучасних вимог до її якості: щоб документація була зручною у використанні і максимально інформативною. Тому проблема побудови якісної технічної документації є нагальною та актуальною.
scite is a Brooklyn-based organization that helps researchers better discover and understand research articles through Smart Citations–citations that display the context of the citation and describe whether the article provides supporting or contrasting evidence. scite is used by students and researchers from around the world and is funded in part by the National Science Foundation and the National Institute on Drug Abuse of the National Institutes of Health.
hi@scite.ai
10624 S. Eastern Ave., Ste. A-614
Henderson, NV 89052, USA
Copyright © 2024 scite LLC. All rights reserved.
Made with 💙 for researchers
Part of the Research Solutions Family.