Abstract
User documentation is crucial in any product development lifecycle, Software or hardware. Without it, stakeholders struggle to comprehend the more complex functionalities—usually the most valuable critical components of any software. Providing comprehensive and easily accessible product documentation always helps avoid this worst‑case scenario. It enhances the user experience and takes full advantage of the Software. Many organizations prefer the unstructured local authoring license that is easy to use for the stakeholders involved in developing the product documentation. However, setting up an automated pipeline for this is a complex approach. Based on our several years of industry experience, we have presented an automated documentation deployment workflow in this article. This workflow helps stakeholders involved in decision-making to lay out a plan for documentation scope for the SaaS delivery. Following a doc-as-a-code approach, our proposed method will help the organization to save time and focus more on managing the end-user technical documentation related to SaaS customization and the application release delivery.
This is a preview of subscription content, log in via an institution to check access.
Access this chapter
Tax calculation will be finalised at checkout
Purchases are for personal use only
Similar content being viewed by others
References
Theunissen T, van Heesch U, Avgeriou P: A Mapping Study on Documentation in Continuous Software Development, Information, and Software Technology, 142:106733 (2022). ISSN 0950–5849,https://doi.org/10.1016/j.infsof.2021.106733.
Cho H, Lee S, Kang S: Classifying issue reports according to feature descriptions in a user manual based on a deep learning model. Inf Softw Technol 142:106743 (2022). https://doi.org/10.1016/j.infsof.2021.106743
Poppendieck M, Poppendieck T: Lean software development: an agile toolkit. Computer (ISSN: 0018–9162) 36 (8) (2003). http://dx.doi.org/https://doi.org/10.1109/MC.2003.1220585
Prause CR, Durdik Z: Architectural design, and documentation: Waste in agile development? In: 2012 International Conference on Software and System Process, ICSSP 2012 - Proceedings, in: ICSSP’12, IEEE Press, Piscataway,NJ, USA, pp 130–134 (2012). https://doi.org/10.1109/ICSSP.2012.6225956
Wattanakriengkrai S, Chinthanet B, Hata H, Kula RG, Treude C, Guo J, Matsumoto K (2022) Github repositories with links to academic papers: Public access, traceability, and evolution. J Syst Softw 183:11111
Jackson V, van der Hoek A, Prikladnicki R: Collaboration Tool Choices and Use in Remote Software Teams: Emerging Results from an Ongoing Study. 2022 IEEE/ACM 15th International Workshop on Cooperative and Human Aspects of Software Engineering (CHASE), pp 76–80 (2022). https://doi.org/10.1145/3528579.3529171
Hutton DM: Clean Code: A Handbook of Agile Software Craftsmanship. In: Martin RC (ed.) Clean Code: A Handbook of Agile Software Craftsmanshi, 27, (99) Prentice-Hall, ISBN: 9–780–13235–088–4 , In: Kybernetes 38.6 (June 2009), pp. 1035–1035 (2009). https://doi.org/10.1108/03684920910973252
Manteuffel C, Tofan D, Koziolek H, Goldschmidt T, Avgeriou P: Industrial implementation of a documentation framework for architectural decisions. in: Proceedings - Working IEEE/IFIP Conference on Software Architecture 2014, WICSA 2014, IEEE, pp 225–234 (2014). https://doi.org/10.1109/WICSA.2014.32
Hoda R, Noble J, Marshall S: How much is just enough? Some documentation patterns on agile projects. In: Proceedings of the 15th European Conference on Pattern Languages of Programs, ACM, pp 1–13 (2010). https://doi.org/10.1145/2328909.2328926
Behutiye W, Karhapää P, Costal D, Oivo M, Franch X: Non-functional requirements documentation in agile software development: challenges and solution proposal. In: International Conference on Product-Focused Software Process Improvement, Springer, pp 515–522 (2017). https://doi.org/10.1007/978-3-319-69926-4_41
Thomchick R (2018) Improving access to API documentation for developers with docs-as-code-as-a-service. Proceedings of the Assoc Inf Science Technol. 55:908–910. https://doi.org/10.1002/pra2.2018.14505501171
Author information
Authors and Affiliations
Corresponding author
Editor information
Editors and Affiliations
Rights and permissions
Copyright information
© 2023 The Author(s), under exclusive license to Springer Nature Singapore Pte Ltd.
About this paper
Cite this paper
Satapathy, B.S., Satapathy, S.S., Singh, S.I., Chakraborty, J. (2023). Continuous Integration and Continuous Deployment (CI/CD) Pipeline for the SaaS Documentation Delivery. In: Hasteer, N., McLoone, S., Khari, M., Sharma, P. (eds) Decision Intelligence Solutions. InCITe 2023. Lecture Notes in Electrical Engineering, vol 1080. Springer, Singapore. https://doi.org/10.1007/978-981-99-5994-5_5
Download citation
DOI: https://doi.org/10.1007/978-981-99-5994-5_5
Published:
Publisher Name: Springer, Singapore
Print ISBN: 978-981-99-5993-8
Online ISBN: 978-981-99-5994-5
eBook Packages: Intelligent Technologies and RoboticsIntelligent Technologies and Robotics (R0)