[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"detail-sidebar-cat-0-en-105":3,"doc-seo-657556-105":59,"doc-detail-657556-en":130},{"code":4,"msg":5,"data":6},0,"success",[7,13,18,23,28,33,38,43,48,51,55],{"id":8,"doc_module":4,"doc_module_name":9,"category_name":10,"show_sort_weight":11,"slug":12},1,"Document","Story & Novel",90,"story-novel",{"id":14,"doc_module":4,"doc_module_name":9,"category_name":15,"show_sort_weight":16,"slug":17},2,"Literature",80,"literature",{"id":19,"doc_module":4,"doc_module_name":9,"category_name":20,"show_sort_weight":21,"slug":22},4,"Exam",70,"exam",{"id":24,"doc_module":4,"doc_module_name":9,"category_name":25,"show_sort_weight":26,"slug":27},5,"Comic",60,"comic",{"id":29,"doc_module":4,"doc_module_name":9,"category_name":30,"show_sort_weight":31,"slug":32},6,"Technology",50,"technology",{"id":34,"doc_module":4,"doc_module_name":9,"category_name":35,"show_sort_weight":36,"slug":37},7,"Healthcare",40,"healthcare",{"id":39,"doc_module":4,"doc_module_name":9,"category_name":40,"show_sort_weight":41,"slug":42},8,"Research & Report",30,"research-report",{"id":44,"doc_module":4,"doc_module_name":9,"category_name":45,"show_sort_weight":46,"slug":47},9,"Religion & Spirituality",20,"religion-spirituality",{"id":46,"doc_module":4,"doc_module_name":9,"category_name":49,"show_sort_weight":46,"slug":50},"World Cup","world-cup",{"id":52,"doc_module":4,"doc_module_name":9,"category_name":53,"show_sort_weight":52,"slug":54},10,"Lifestyle","lifestyle",{"id":56,"doc_module":4,"doc_module_name":9,"category_name":57,"show_sort_weight":24,"slug":58},19,"General","general",{"code":4,"msg":60,"data":61},"ok",{"site_id":62,"language":63,"slug":64,"title":65,"keywords":66,"description":67,"schema_data":68,"social_meta":123,"head_meta":125,"extra_data":127,"updated_unix":129},105,"en","technical-design-in-an-agile-environment-why-technical-documentation-matters","Technical design in an agile environment - Why technical documentation matters","","Technical design in UML is presented for Angular-based web applications, clarifying key terminology such as the definition of a web application and how it differs from broader references. The text argues that in agile teams using Scrum or Kanban, design documentation is still valuable despite manifesto emphasis on working software. It explains how technical models reduce bad structure risks, lower bug rates, improve integration of changes, and help rectify structural flaws, while emphasizing an appropriate detail level and iterative prototyping.",{"@graph":69,"@context":122},[70,84,105],{"@type":71,"itemListElement":72},"BreadcrumbList",[73,77,79,82],{"item":74,"name":75,"@type":76,"position":8},"https://docshare.wps.com","Home","ListItem",{"item":78,"name":9,"@type":76,"position":14},"https://docshare.wps.com/document/",{"item":80,"name":30,"@type":76,"position":81},"https://docshare.wps.com/document/technology/",3,{"item":83,"name":65,"@type":76,"position":19},"https://docshare.wps.com/document/technical-design-in-an-agile-environment-why-technical-documentation-matters/657556/",{"url":83,"name":65,"@type":85,"image":86,"author":91,"headline":65,"publisher":94,"fileFormat":97,"inLanguage":63,"description":67,"dateModified":98,"datePublished":99,"encodingFormat":97,"isAccessibleForFree":100,"interactionStatistic":101},"DigitalDocument",{"url":87,"@type":88,"width":89,"height":90},"https://docshare.wps.com/thumbnails/technical-design-in-an-agile-environment-why-technical-documentation-matters/657556.png","ImageObject",300,407,{"name":92,"@type":93},"Cipher","Person",{"url":74,"name":95,"@type":96},"DocShare","Organization","application/pdf","2026-10-30","2026-10-26",true,{"@type":102,"interactionType":103,"userInteractionCount":19},"InteractionCounter",{"@type":104},"ViewAction",{"@type":106,"mainEntity":107},"FAQPage",[108,114,118],{"name":109,"@type":110,"acceptedAnswer":111},"How does the paper define a web application?","Question",{"text":112,"@type":113},"A web application is a client application executed by a web browser, typically written in HTML, CSS, and JavaScript. The paper deliberately limits the scope to exclude back-end software to support the later argument and avoid ambiguity.","Answer",{"name":115,"@type":110,"acceptedAnswer":116},"Why does the paper recommend technical documentation in an agile environment?",{"text":117,"@type":113},"Agile methods like Scrum or Kanban may not require design documentation, and the Agile Manifesto favors working software. The paper argues that documentation remains valuable because it provides insight into software structure, reducing the likelihood of problems and rework.",{"name":119,"@type":110,"acceptedAnswer":120},"What level of detail should technical design documentation have?",{"text":121,"@type":113},"The design should be documented up to a certain level of detail—sufficient to find more details in the source code later. If the code is not written yet, the design should enable developers to fill in missing details appropriately.","https://schema.org",{"og:url":83,"og:type":124,"og:title":65,"og:site_name":95,"og:description":67},"article",{"robots":126,"canonical":83},"index,follow",{"doc_id":128,"site_id":62},657556,1793051387,{"code":4,"msg":5,"data":131},{"doc_id":128,"user_id":132,"nickname":92,"user_avatar":133,"doc_module":4,"category_id":29,"category_name":30,"doc_title":65,"doc_description":67,"doc_content":134,"file_id":135,"file_url":136,"file_type":137,"file_size":138,"view_count":19,"is_deleted":4,"is_public":8,"is_downloadable":8,"audit_status":8,"page_count":139,"language":140,"language_code":63,"site_id":62,"html_lang":63,"table_of_contents":141,"faqs":142,"seo_title":143,"seo_description":67,"update_tm":144,"read_time":41},687208528416,"https://ap-avatar.wpscdn.com/davatar_9964176cb1d06d4a9deccf72a44ae3dc","It seems to be a contradiction. ‘Technical design’ is something for the old-timers in the IT business, those who think in terms of waterfall methods. ‘Angular’ is the toy of the Web nerds, rapidly building a nice app. Do you think they will wait for design documentation? This paper explains that technical design is important for professional web applications and provides concrete examples of how such a design could look like in case the Angular framework is used. I will focus on the form of design rather than design patterns and decisions.  \nTechnical design in UML for Angular applications  \nand other web applications  \nTerminology  \nTo avoid misunderstandings, I will first give a definition. In this paper, a web application is a client application executed by a web browser. This implies that, almost certainly, the application is written in HTML, CSS and JavaScript. Such an application is usually only one part of a solution, the other components running on one or several servers. Using this definition, I deliberately deviate from definitions like the one given by Wikipedia, which also considers the back end software to be part of the web application, because I need that for this paper. Besides, with my definition, the term is better delineated: many web applications use multiple APIs, including third party APIs (like Google’s) and with the Wikipedia definition, it would be unclear which software exactly belongs to the web application.  \nAn Angular application is a web application based on the Angular framework, an open source framework developed by Google. In this paper, we assume version 2 or higher.  \nUML means Unified Modeling Language, a standard notation for software models, maintained by the Object Management Group. UML defines all kinds of concepts and their graphical representations. For example, a class is represented by a rectangle.  \nTo understand this paper, some basic knowledge of Angular and UML is required.  \nHans Admiraal, 2017 [1](1 www.admiraalit.nl)[ www.admiraalit.nl](1 www.admiraalit.nl)  \nTechnical design in an agile environment  \nIt should be obvious, but let me put this question anyway: Why would you create functional and technical models for a web application? Nowadays, most web applications are developed by teams that have adopted an agile development method, like Scrum or Kanban. These methods do not prescribe the production of design documentation, which may give people the impression that such documentation is not needed. Furthermore, the Agile Manifesto says: “We value working software over comprehensive documentation”. The fact that the same manifesto also states that documentation is valuable, is sometimes ignored. Good developers can build high-quality applications without any technical design, but nevertheless, I plead for documenting any professional application up to a certain level of detail, not sacrificing an iterative process or prototyping. Why? Because it saves time and money and the users will get a better application! There is one precondition: the developers must support it. The savings arise from the fact that the design provides insight into the software structure and thereby reduces the chance of a bad structure (spaghetti code, inconsistencies, code duplication) . Both the insight into the structure of the software and the high quality of the structure subsequently diminish    \na. the chance of bugs and consequently the time it takes to solve bugs;  \nb. the time it takes to determine the best way of integrating a particular change or extension;  \nc. the time it takes to rectify flaws in the structure later on.  \nLike I said, applications need technical documentation up to a certain level of detail, i.e. not too detailed. The design should be sufficient to subsequently find more details in the source code. If the source code has not been written yet, the design should be sufficient for the developer to fill in the details on his own discretion. By the way, it is not always requir","cbCaiqLlKWpet0PF","https://ap.wps.com/l/cbCaiqLlKWpet0PF","pdf",270277,12,"English","# Terminology\n# Technical design in an agile environment\n## Why create functional and technical models\n## Preconditions, benefits, and implementation approach\n# The context of a web application\n# Architecture","[{\"question\":\"How does the paper define a web application?\",\"answer\":\"A web application is a client application executed by a web browser, typically written in HTML, CSS, and JavaScript. The paper deliberately limits the scope to exclude back-end software to support the later argument and avoid ambiguity.\"},{\"question\":\"Why does the paper recommend technical documentation in an agile environment?\",\"answer\":\"Agile methods like Scrum or Kanban may not require design documentation, and the Agile Manifesto favors working software. The paper argues that documentation remains valuable because it provides insight into software structure, reducing the likelihood of problems and rework.\"},{\"question\":\"What level of detail should technical design documentation have?\",\"answer\":\"The design should be documented up to a certain level of detail—sufficient to find more details in the source code later. If the code is not written yet, the design should enable developers to fill in missing details appropriately.\"}]","Technical design in an agile environment - Why technical documentation matters | PDF",1792982629]