Please use this identifier to cite or link to this item: http://elartu.tntu.edu.ua/handle/lib/32717

Title: Software development documenting – documentation types and standards
Other Titles: Документування при розробці програмного забезпечення – типи та стандарти документації
Authors: Синько, Анна Іванівна
Пелещишин, Андрій Миколайович
Synko, Anna
Peleshchyshyn, Andriy
Affiliation: Національний університет «Львівська політехніка», Львів, Україна
Lviv Polytechnic National University, Lviv, Ukraine
Bibliographic description (Ukraine): Synko A. Software development documenting – documentation types and standards / Anna Synko, Andriy Peleshchyshyn // Visnyk TNTU. — Tern. : TNTU, 2020. — Vol 98. — No 2. — P. 120–128.
Bibliographic description (International): Synko A., Peleshchyshyn A. (2020) Software development documenting – documentation types and standards. Visnyk TNTU (Tern.), vol. 98, no 2, pp. 120-128.
Is part of: Вісник Тернопільського національного технічного університету, 2 (98), 2020
Scientific Journal of the Ternopil National Technical University, 2 (98), 2020
Journal/Collection: Вісник Тернопільського національного технічного університету
Issue: 2
Volume: 98
Issue Date: 10-Jun-2020
Submitted date: 17-Apr-2020
Date of entry: 29-Sep-2020
Publisher: ТНТУ
TNTU
Place of the edition/event: Тернопіль
Ternopil
DOI: https://doi.org/10.33108/visnyk_tntu2020.02.120
UDC: 004.91
Keywords: документація
програмне забезпечення
програмна документація
технічне завдання
стандарти документації
вимоги до документації
користувацька документація
маркетингова документація
архітектурна/проектна документація
documentation
software
software documentation
technical requirement
documentation standards
documentation requirements
user manuals
marketing documentation
architecture documentation
Number of pages: 9
Page range: 120-128
Start page: 120
End page: 128
Abstract: Через стрімкий розвиток різноманітних програмних продуктів, додатків, інформаційних систем, що можуть бути розроблені як для державного або комерційного сектора, так і для звичайних користувачів, виникає потреба у написанні великої кількості технічної документації, що містить опис створюваного продукту з різних точок зору. Зрозуміло, що кожне програмне забезпечення має свій життєвий цикл, який реалізується за допомогою моделей (до найпоширеніших з яких належать: каскадна або водоспадна, інкрементна, спіральна моделі тощо) та етапів, кожен з яких повинен супроводжуватися документацією. В роботі наведено для чого взагалі потрібна документація – «внутрішні» та «зовнішні» причини. Тепер, для кращого уявлення звідки взагалі формується документація, було описано процес спочатку при отриманні проекту від замовника, і, надалі, побудовано загальну схему організації зв’язку між документами, для проектування якої рекомендується застосовувати Use Case засоби. Після побудови такої схеми необхідно провести документування відповідно до типів документації: документування вимог (необхідні для визначення атрибутів, можливостей, характеристик та властивостей системи тощо, а також вони є описом того, що конкретне програмне забезпечення робить або буде робити), архітектурна/проектна (наведено огляд програмного забезпечення, що включає опис робочого середовища і принципів, які повинні бути використані при створенні програмного продукту), технічна (надає певний текст, що описує різні аспекти того, що саме робить програмний код. Подібна документація має сильно виражений технічний характер і в основному використовується для визначення й описування API, структур даних і алгоритмів за допомогою автоматизованих засобів, генераторів), користувацька (містить керівництво для кінцевих користувачів, адміністраторів системи та іншого персоналу. Рекомендовано застосовувати три підходи до організації даного типу документації) та маркетингова документації (призначена для рекламування, поширення, розповсюдження програмного продукту за допомогою сучасних інструментів просування). Також у роботі наведено стандарти (безкоштовні та платні), застосування яких робить документацію повною та якісною (відповідно до вимог нормативних документів).
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.
URI: http://elartu.tntu.edu.ua/handle/lib/32717
ISSN: 2522-4433
Copyright owner: © Тернопільський національний технічний університет імені Івана Пулюя, 2020
URL for reference material: https://doi.org/10.33108/visnyk_tntu2019.03.116
https://doi.org/10.33108/visnyk_tntu2017.04.135
References (Ukraine): 1. Шикина В. Е. Техническая документация информационных систем: учебное пособие. Ульяновск: УлГТУ, 2018. 92 с .
2. Краснянский М. Н. Проектирование информационных систем управления документооборотом научно-образовательных учреждений: монография. Тамбов: Изд-во ФГБОУ ВПО «ТГТУ», 2015. 216 с.
3. Суркова Н. Е., Гурьянов В. М. Руководство по использованию стандартов при разработке сложных программных средств: учеб. пособие. М.: МАДИ, 2018. 92 с.
4. Плескач В. Л., Затонацька Т. Г. Інформаційні системи і технології на підприємствах: підручникю К.: Знання, 2011. 718 с.
5. Комова М. В., Пелещишин А. M., Білущак Т. М. Керування документаційними процесами. Львів: Вид-во НУ «Львівська політехніка», 2013.
6. Алексенко О. В. Технології програмування та створення програмних продуктів: конспект лекцій для студ. напряму підготовки 6.050101 «Комп’ютерні науки» усіх форм навчання. Суми: СумДУ, 2013. 133 с.
7. Пелещишин A. M., Трач О. Р. Визначення елементів соціально-орієнтованих ризиків при організації життєвого циклу віртуальної спільноти. Науковий журнал «Безпека інформації». 2017. Вип. 23. № 2. С. 130–135.
8. Valacich, Joseph S., George, Joey F. Modern Systems Analysis and Design (8th Edition). Publisher: Pearson, 2017. 545 p.
9. ГОСТ Р ИСО/МЭК 15910-2002: Процесс создания документации пользователя программного средства. М.: ИПК Издательство стандартов, 2002.
10. Лактіонов Є. Ю., Малицький А. Ю. Використання XML для підготовки спеціалізованої програмної документації. Вісник НТУУ «КПІ». Сер.: Інформатика, управління та обчислювальна техніка. 2010. Вип. 52. С. 131–136.
11. ГОСТ 19781–90: Единая система программной документации. Обеспечение систем обработки информации программное. Введ. 01.01.92. М.: Изд-во стандартов, 1992. 14 с.
12. Шапошник С. П. Управління документацією в організації. Державне будівництво. 2008. Вип. 64. № 1.
13. Жирякова І. А., Гадецька З. М. Методологія функціонального моделювання як засіб представлення проектної документації в ІТ-аутсорсінгу. Харків: КПІ, 2010. С. 122–128.
14. Kovalenko I., Shved A., Davydenko Ye. Choice of software development technologies based on pareto- optimal solutions. Scientific Journal of TNTU. 2019. Vol 95. No. 3. P. 116–122. https://doi.org/10.33108/visnyk_tntu2019.03.116.
15. Bouraou N., Tsybulnik S., Rupich S. Problems of Intellectualizing in SHM Systems: Estimation, Prediction, Multi-Class Recognition. Scientific Journal of TNTU. 2017. Vol. 88. No. 4. P. 135–144. https://doi.org/10.33108/visnyk_tntu2017.04.135.
16. Сущик А. М. Метод створення документації для REST API на основі тестів: магіст. р. на здобуття другого рівня вищої освіти. Київ. КПІ ім. І. Сікорського, 2019. 130 с.
17. Лаврищева Е. М. Software Engineering компьютерных систем. Парадигмы, технологии и CASE- средства программирования. К.: Наук. думка, 2013. 283 с.
18. Смиченко О. С., Система для пошуку та оптимізації рекламних кампаній: бакалавр. на здобуття першого рівня вищої освіти. 467200.001. Київ, 2019. 82 с.
19. Федорович Р. В. та ін. Маркетинговий інструментарій управління попитом на товари і послуги / за ред. проф. Р. В. Федоровича. Тернопіль: Підручники і посібники, 2016. 244 с.
20. Антоненко І. До історії розроблення міжнародного стандарту ISO 15489-2001 «Інформація та документація. Управління документацією». Архівознавство. Археографія. Джерелознавство. 2003. Вип. 6. С. 73–83.
21. Антоненко І. Проект концепції впровадження в Україні норм міжнародного стандарту ISO 15489-2001 «Інформація та документація. Управління документацією». Студії з арх. cправи та документознавства. К., 2004. Т. 11. С. 172–177.
22. ГОСТ 34.602-89. Техническое задание на создание автоматизированной системы. М.: Стандартинформ, 2009.
23. IEEE Std 1016-1998. IEEE Recommended Practice for Software Design Descriptions. IEEE-SA Standards Board 1998. 16 p.
References (International): 1. Shikina V. E. Tekhnicheskaya dokumentatsiya informatsionnykh sistem: uchebnoye posobiye. Ulyanovsk: UlSTU, 2018. 92 p. [In Russian].
2. Krasnyanskiy M. N. and others Proyektirovaniye informatsionnykh sistem upravleniya dokumentooborotom nauchno-obrazovatelnykh uchrezhdeniy: monograph. Tambov: TSTU 2015. 216 p. [In Russian].
3. Surkova N. E., Gurianov V. M. Rukovodstvo po ispolzovaniyu standartov pri razrabotke slozhnykh programmnykh sredstv: ucheb. posobiye. Moscow, MADI, 2018. 92 p. [In Russian].
4. Pleskach V. L. Zatonats'ka T. H. Informatsiyni systemy i tekhnolohiyi na pidpryyemstvakh: pidruchnyk. Kiev, Znannia Publ., 2011. 718 p. [In Ukrainian].
5. Komova M. V., Peleshchyshyn A. M., Bilushchak T. M. Keruvannya dokumentatsiynymy protsesamy, Lviv: Publisher: Lviv polytechnic national university, 2013. [In Ukrainian].
6. Aleksenko O. V. Tekhnolohiyi prohramuvannya ta stvorennya prohramnykh produktiv: konspekt lektsiy dlya stud. napryamu pidhotovky 6.050101 “Computer science” all forms. Sumy: Sumy State University, 2013. 133 p. [In Ukrainian].
7. Peleshchyshyn A. M., Trach O. R. Vyznachennya elementiv sotsial'no-oriyentovanykh ryzykiv pry orhanizatsiyi zhyttyevoho tsyklu virtual'noyi spil'noty. Ukrainian Scientific Journal of Information Security, 2017, no. 23, vol. 2, 130–135 pp. [In Ukrainian].
8. Valacich, Joseph S., George, Joey F. Modern Systems Analysis and Design (8th Edition). Publisher: Pearson, 2017, 545 p.
9. GOST R ISO/MEK 15910-2002 – Protsess sozdaniya dokumentatsii polzovatelya programmnogo sredstva. Moscow, IPK Standards Publishing. 2002. [In Russian].
10. Laktionov Ye. Yu., Malyts’kyy A. Yu. Vykorystannya XML dlya pidhotovky spetsializovanoyi prohramnoyi dokumentatsiyi. National Technical University of Ukraine “Igor Sikorsky Kyiv Polytechnic Institute” Series: Informatics, control and computer engineering. 2010, no. 52, 131–136 pp. [In Ukrainian].
11. GOST 19781–90 Software of data processing systems. Terms and definitions. Introduced on 01.01.92. Moscow, Gosstandart of Russia: Publishing House of Standards, 1992, 14 p. [In Russian].
12. Shaposhnyk S. P. Upravlinnya dokumentatsiyeyu v orhanizatsiyi. Kharkiv Regional Institute of Public Administration: State building, 2008, no. 64, vol. 1 [in Ukrainian].
13. Zhyryakova I. A., Hadets'ka Z. M. Metodolohiya funktsional'noho modelyuvannya yak zasib predstavlennya proektnoyi dokumentatsiyi v IT-aut·sorsinhu. Kharkiv: National Technical University “Kharkiv Polytechnic Institute”, 2010, 122–128 pp. [in Ukrainian].
14. Kovalenko I., Shved A., Davydenko Ye. (2019) Choice of software development technologies based on pareto-optimal solutions. Scientific Journal of TNTU (Tern.), vol. 95, no. 3, pp. 116–122. https://doi.org/10.33108/visnyk_tntu2019.03.116.
15. Bouraou N., Tsybulnik S., Rupich S. (2017) Problems of Intellectualizing in SHM Systems: Estimation, Prediction, Multi-Class Recognition. Scientific Journal of TNTU (Tern.), vol. 88, no. 4, pp. 135–144. https://doi.org/10.33108/visnyk_tntu2017.04.135.
16. Sushchyk A. M. Metod stvorennya dokumentatsiyi dlya REST API na osnovi testiv: master's thesis for the second level of higher education. Kiev. National Technical University of Ukraine “Igor Sikorsky Kyiv Polytechnic Institute”, 2019. 130 p. [In Ukrainian].
17. Lavrishcheva E. M. Software Engineering kompyuternykh sistem. Paradigmy. tekhnologii i CASE- sredstva programmirovaniya. Kiev, Naukova Dumka Publ., 2013, 283 p. [In Russian].
18. Smychenko O. S., Systema dlya poshuku ta optymizatsiyi reklamnykh kampaniy: bachelor's degree to obtain the first level of higher education. 467200.001. Kiev, 2019. 82 p. [In Ukrainian].
19. Fedorovych R. V. ta in. Marketynhovyy instrumentariy upravlinnya popytom na tovary i posluhy / edited by prof. R. V. Fedorovycha. Ternopil: Textbooks and manuals, 2016. 244 p. [In Ukrainian].
20. Antonenko I. Do istoriyi rozroblennya mizhnarodnoho standartu ISO 15489-2001 “Information and documentation. – Document management”. Archival science. Archaeography. Source studies. Kiev. 2003. No. 6. 73–83 pp; Draft concept of implementation of international standard norms in Ukraine ISO 15489-2001 “Information and documentation. – Document management”. Studies with arch. cases and documentation. Kiev, 2004, 172–177 pp [in Ukrainian].
21. GOST 34.602-89. Information technology. Set of standards for automated systems. Technical directions for automated system making. Moscow, STANDARTINFORM. 2009. [In Russian].
22. IEEE Std 1016-1998. IEEE Recommended Practice for Software Design Descriptions. IEEE-SA Standards Board 1998. 16 p.
Content type: Article
Appears in Collections:Вісник ТНТУ, 2020, № 2 (98)



Items in DSpace are protected by copyright, with all rights reserved, unless otherwise indicated.