The article explores the methodology for creating technical documentation in software development projects, taking into account the principles of Agile and DevOps. It proposes formal approaches for building a document system as an integrated part of the IT project life cycle. The study examines the stages of transforming user stories into structured documents, the role of security templates, prototyping, and source code as inputs for generating specifications. Emphasis is placed on automated documentation, including auto- generation of API documentation, test reports, and the use of traceability matrices. The relationship between documents and project stages (epics, commits, tests) within the CI/CD pipeline is analyzed. The paper also presents formalisms and a mathematical model, diagrams, and architectural approaches that ensure the completeness, relevance, and structured nature of technical documentation.
- Aimar, A. (2001). Introduction to software documentation (Technical report). CERN, IPT Group, IT Division. https://cds.cern.ch/record/572356
- Behutiye, W., Rodríguez, P., Oivo, M., Aaramaa, S., Partanen, J., & Abhervé, A. (2022). Towards optimal quality requirement documentation in agile software development: A multiple case study. Journal of Systems and Software, 183, 111112. https://doi.org/10.1016/j.jss.2021.111112
- Blome, M. (2025, January 29). Automation in technical documentation: Faster, smarter, better. Adoc Studio Blog.https://www.adocstudio.app/blog/automation-in-technical-documentation
- Brockmann, R. J. (1990). Writing better computer user documentation: From paper to hypertext. John Wiley & Sons. Buchgeher, G., Klammer, C., Dorninger, B., & Kern, A. (2018). Providing technical software documentation as a service:
- An industrial experience report. In Proceedings of the Asia-Pacific Software Engineering Conference (APSEC 2018) (pp. 581–590). IEEE. https://doi.org/10.1109/APSEC.2018.00073
- IEEE Standards Association. (2020). IEEE Std 1063-2020: IEEE standard for software user documentation. Institute of Electrical and Electronics Engineers. https://doi.org/10.1109/IEEESTD.2020.9055273
- Kolomiiets, I. (2024). Mastering technical documentation in DevOps. Attract Group. https://attractgroup.com/blog/ mastering-technical-documentation-in-devops/
- Low, R., & Ford, H. (1995). Writing user documentation: A practical guide for those who want to be read. Prentice Hall. Rai, S., Belwal, R. C., & Gupta, A. (2022). A review on source code documentation. ACM Transactions on Management Information Systems, 13(5). https://doi.org/10.1145/3519312
- Ramesh, B., Cao, L., & Baskerville, R. (2010). Agile requirements engineering practices and challenges: An empirical study. Information Systems Journal, 20(5), 449–480. https://doi.org/10.1111/j.1365-2575.2007.00259.x
- Ries, R. (1990). IEEE standard for software user documentation. In Proceedings of the International Conference on Professional Communication (pp. 66–68). IEEE. https://doi.org/10.1109/IPCC.1990.111154
- Synko, A., & Peleshchyshyn, A. (2020). Software development documenting – Documentation types and standards. Scientific Journal of the Ternopil National Technical University, 98(2), 120–128. https://doi.org/10.33108/visnyk- tntu2020.02