Abstract
When working with system development and design, one is urged to write design documentation. The design document should be constructed in a specific way and should include all necessary information. However, the users of the design document are not stated and seem to be secondary. This study's aim is therefore to investigate who the users are. A literature review was conducted to answer the question. The literature showed that design documentation is a tool to communicate design and it should include relatable information. The essential role of design documents within software projects were also discussed and hence, they are included in this study. The literature review revealed that the system developer and the individuals which are involved in the production of the software is the users. To investigate this further, a hypothesis was formed and thereafter an observation was done, where videos of system developers were observed. The observation showed that system developers do not verbalize the importance of design documentation. Secondly, the study showed how unidentified the users are and that the discussion of who they are is limited. Furthermore, the design documentation is a valuable tool for communicating amongst other designers but if the documentation is not read, it is argued to be a waste of valuable time. The results presented within this study, therefore indicates that a definition of who the user is of design documentation is required.
Access this chapter
Tax calculation will be finalised at checkout
Purchases are for personal use only
Similar content being viewed by others
References
AltexSoft, Software r & d engineering: Technical documentation in software development: types, best practices, and tools. https://www.altexsoft.com/blog/business/technical-documentation-in-software-development-types-best-practices-and-tools/?utm_source=MediumCom&utm_medium=referral (2020). Accessed 4 Jan 2021
Amigoscode: A day in the life of a software engineer in London | STARLING | 2020, YouTube. https://www.youtube.com/watch?v=oS-m5-XikwA (2020). Accessed 5 Jan 2021
Brown, D.M. (ed.): Communicating Design: Developing Web Site Documentation for Design and Planning. New Riders Publishing, Berkeley (2010)
Chau Codes: Day in the life of a self-taught software developer, YouTube. https://www.youtube.com/watch?v=VkKFEUZJ0DA (2020). Accessed 11 Jan 2021
Clever Programmer: Day in the life of a software developer, YouTube. https://www.youtube.com/watch?v=Zwu2HjU7pXY (2019). Accessed 5 Jan 2021
Fox, C.J.: Why writing software design documents matters. https://www.toptal.com/freelance/why-design-documents-matter (n.d). Accessed 4 Jan 2021
Hammond, J.: A REAL day in the life of a software engineer, YouTube. https://www.youtube.com/watch?v=j1fc0FlCjyI (2020). Accessed 5 Jan 2021
Holland, B.: Visual studio live share can do that? Smashing Magazine, 18 September. https://www.smashingmagazine.com/2018/09/visual-studio-live/ (2020). Accessed 4 Jan 2021
Khan, O.: Day in the life of an amazon software engineer (WFH), YouTube. https://www.youtube.com/watch?v=I4W9blxeHEU (2020). Accessed 11 Jan 2021
Jensen, M.: 5 reasons why design documentation is important. http://steensolutions.com/2015/12/5-reasons-why-design-documentation-is-important/ (n.d). Accessed 4 Jan 2021
Josh and Katie: Day in the life of a twitter software engineer, YouTube. https://www.youtube.com/watch?v=sS6O7Yp5xmg (2020). Accessed 5 Jan 2021
Morales, J., Rusu, C., Quinones, D.: Programmer experience: a systematic mapping. IEEE Latin Am. Trans. 1111–1118 (2020). https://doi.org/10.1109/TLA.2020.9099749
Nguyen, S.: A day in the life of a Google Software Engineer | work-from-home Edition, YouTube. https://www.youtube.com/watch?v=a0glBQXOcl4 (2020). Accessed 5 Jan 2021
Saddler, H.J.: Understanding design representations ACM interactions. Interactions 17–24 (2001). https://doi.org/10.1145/379537.379542
Voorhees, P.D.: Guide to Efficient Software Design An MVC Approach to Concepts, Structures, and Models. Springer International Publishing, Cham (2020). https://doi.org/10.1007/978-3-030-28501-2
Product Manager: A day in the life of a software engineer at eBay (Product Manager Edition), YouTube. https://www.youtube.com/watch?v=KE0Yjp1bbiM (2019). Accessed 11 Jan 2021
Pyle, T.: Guidelines for creating effective software design documentation. Intercom (2020)
Acknowledgments
Lastly, but no means least, I would like to thank my classmates and teacher for encouraging and inspiring discussions. I would also like to express my deepest appreciation to my teacher Markus Lahtinen for encouragement and support for making this into a publicised poster.
Author information
Authors and Affiliations
Editor information
Editors and Affiliations
Rights and permissions
Copyright information
© 2021 Springer Nature Switzerland AG
About this paper
Cite this paper
Cadier, A. (2021). Unidentified Users of Design Documentation. In: Stephanidis, C., Antona, M., Ntoa, S. (eds) HCI International 2021 - Late Breaking Posters. HCII 2021. Communications in Computer and Information Science, vol 1498. Springer, Cham. https://doi.org/10.1007/978-3-030-90176-9_2
Download citation
DOI: https://doi.org/10.1007/978-3-030-90176-9_2
Published:
Publisher Name: Springer, Cham
Print ISBN: 978-3-030-90175-2
Online ISBN: 978-3-030-90176-9
eBook Packages: Computer ScienceComputer Science (R0)