logo logo
Українською English

Вхід

Логін
Пароль
Зареєструватися 

Корисні посилання

tntu logo
 
GoogleScholarLogo
 
 
logo


Software development documenting – documentation types and standards

НазваSoftware development documenting – documentation types and standards
Назва англійськоюSoftware development documenting – documentation types and standards
АвториAnna Synko; Andriy Peleshchyshyn
ПринадлежністьLviv Polytechnic National University, Lviv, Ukraine
Бібліографічний описSoftware development documenting – documentation types and standards / Anna Synko; Andriy Peleshchyshyn // Scientific Journal of TNTU. — Tern. : TNTU, 2020. — Vol 98. — No 2. — P. 120–128.
Bibliographic description:Synko A.; Peleshchyshyn A. (2020) Software development documenting – documentation types and standards. Scientific Journal of TNTU (Tern.), vol 98, no 2, pp. 120–128.
DOI: https://doi.org/10.33108/visnyk_tntu2020.02.120
УДК

004.91

Ключові слова

documentation, software, software documentation, technical requirement, documentation standards, documentation requirements, user manuals, marketing documentation, architecture documentation.

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.

ISSN:2522-4433
Перелік літератури
  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. DOI: 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. DOI: 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.
References:
  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. DOI: 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. DOI: 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.
Завантажити

Всі права захищено © 2019. Тернопільський національний технічний університет імені Івана Пулюя.