[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"detail-sidebar-cat-0-en-105":3,"doc-seo-655723-105":59,"doc-detail-655723-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","consistent-architecture-diagrams-for-c-projects-good-documentation-and-diagram-consistency","Consistent architecture diagrams for C++ projects - Good documentation and diagram consistency","","A presentation on creating consistent architecture diagrams for C++ projects to improve documentation quality and team understanding. It covers build scripts, documentation structures, diagrams as code, repository and download server concepts, and versioning across releases. It emphasizes documentation principles such as clarity, skimmability, examples, up-to-date content, and ease of contribution, along with practical use cases like handling issues and avoiding undocumented functions. Key takeaways focus on enforcing precise intent and supporting fast comprehension through consistent visuals.",{"@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/consistent-architecture-diagrams-for-c-projects-good-documentation-and-diagram-consistency/655723/",{"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/consistent-architecture-diagrams-for-c-projects-good-documentation-and-diagram-consistency/655723.png","ImageObject",300,407,{"name":92,"@type":93},"dawugda","Person",{"url":74,"name":95,"@type":96},"DocShare","Organization","application/pdf","2026-10-31","2026-10-25",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},"Why are consistent architecture diagrams important in C++ project documentation?","Question",{"text":112,"@type":113},"They help express intentions precisely and support fast understanding across the team. Consistency also strengthens how documentation communicates architecture and code relationships.","Answer",{"name":115,"@type":110,"acceptedAnswer":116},"What documentation principles are highlighted in the presentation?",{"text":117,"@type":113},"The presentation emphasizes clear and inviting writing, comprehensive coverage, skimmability, practical examples, repetition when useful, keeping content up to date, and making documentation easy to contribute to and find.",{"name":119,"@type":110,"acceptedAnswer":120},"How does the approach relate diagrams to executable or maintainable artifacts?",{"text":121,"@type":113},"It focuses on “diagrams as code” and uses tooling concepts like repositories, build scripts, and versioning to keep diagrams integrated with the project’s documentation workflow.","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},655723,1793074008,{"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":145},3985747870947,"https://ap-avatar.wpscdn.com/davatar_3d24733baf745e90a7e4bdd5f77d97b2","Consistent architecture diagrams for C++ projects  \nMarius Feilhauer  \nAbout me  \n￮ M.Sc. Automotive Engineering @ University Stuttgart  \n￮ PhD thesis Simulation-based validation of advanced driver assistance systems @ HLRS University Stuttgart (Prof. Resch) and ETAS GmbH  \n￮ Working experience @ Robert Bosch GmbH, Aston Martin Ltd. and Porsche AG ￮ Software developer of C++ based simulation models @ ETAS GmbH ￮ Lectures @ University Stuttgart  \n2  \nPublic | Dr. Marius C. Feilhauer -ETAS/ETS-Fe | 2019-11-15  \n© ETAS GmbH 2019. All rights reserved, also regarding any disposal, exploitation, reproduction, editing, distribution, as wel l as in the event of applications for industrial property rights.  \nIntroduction and Overview  \n3  \nTest  \nBuild Scripts  \nDocumentation  ?  \nDiagrams  \nRepository  \nv1 .0 v1 .1  \nv1 .2 v2 .0  \nBuild Tooling  \nPublic | Dr. Marius C. Feilhauer -ETAS/ETS-Fe | 2019-11-15  \n© ETAS GmbH 2019. All rights reserved, also regarding any disposal, exploitation, reproduction, editing, distribution, as wel l as in the event of applications for industrial property rights.  \nDownload Server  \nv1 .0  \nv1 .1  \nv1 .2  \nv2 .0  \nAgenda  \n￮ Good documentation  \n￮ Architecture and code visualization ￮ Consistency  \n￮ Diagrams as code  \n￮ Takeaways & Outlook  \n4  \nPublic | Dr. Marius C. Feilhauer -ETAS/ETS-Fe | 2019-11-15  \n© ETAS GmbH 2019. All rights reserved, also regarding any disposal, exploitation, reproduction, editing, distribution, as wel l as in the event of applications for industrial property rights.  \nGood Documentation  \n5  \nPublic | Dr. Marius C. Feilhauer -ETAS/ETS-Fe | 2019-11-15  \n© ETAS GmbH 2019. All rights reserved, also regarding any disposal, exploitation, reproduction, editing, distribution, as wel l as in the event of applications for industrial property rights.  \nGolden nuggets  \nGuiding principles by atlassian  \nKeep it brief  \nVisuals are key Know your audience  \n[www.atlassian.com/software/confluence/documentation](www.atlassian.com/software/confluence/documentation)  \n6  \nPublic | Dr. Marius C. Feilhauer -ETAS/ETS-Fe | 2019-11-15  \n© ETAS GmbH 2019. All rights reserved, also regarding any disposal, exploitation, reproduction, editing, distribution, as wel l as in the event of applications for industrial property rights.  \nDocumentation use cases  \nTwo examples  \nI get this issue  \nah, we changed this …  \nMh, undocumented  \nfunctions  \nunprofessional  \nAdam Scott, [www.oreilly.com/ideas/the-eight-rules-of-good-documentation](www.oreilly.com/ideas/the-eight-rules-of-good-documentation)  \n7  \nPublic | Dr. Marius C. Feilhauer -ETAS/ETS-Fe | 2019-11-15  \n© ETAS GmbH 2019. All rights reserved, also regarding any disposal, exploitation, reproduction, editing, distribution, as wel l as in the event of applications for industrial property rights.  \nThe eight rules of good documentation  \n1. Write documentation that is inviting and clear  \n2. Write documentation that is comprehensive, detailing all aspects of the project  \n3. Write documentation that is skimmable  \n4. Write documentation that offers examples of how to use the software  \n5. Write documentation that has repetition, when useful  \n6. Write documentation that is up-to-date  \n7. Write documentation that is easy to contribute to  \n8. Write documentation that is easy to find  \nAdam Scott, [www.oreilly.com/ideas/the-eight-rules-of-good-documentation](www.oreilly.com/ideas/the-eight-rules-of-good-documentation)  \n8  \nPublic | Dr. Marius C. Feilhauer -ETAS/ETS-Fe | 2019-11-15  \n© ETAS GmbH 2019. All rights reserved, also regarding any disposal, exploitation, reproduction, editing, distribution, as wel l as in the event of applications for industrial property rights.  \nFast understanding of your intentions  \nProfessional Enforces to express  \npublic image intentions precisely  \nAdditional benefits  \nwhen using consistent diagrams within your documentation  \n9  \n[www.atlassian.com/software/confluence/documentation](www.atlassian.com/software/confl","cbCaioP6J5qUH3AS","https://ap.wps.com/l/cbCaioP6J5qUH3AS","pdf",2817808,37,"English","# Introduction and Overview\n# Test\n## Build Scripts\n## Documentation\n## Diagrams\n## Repository\n# Agenda\n# Good Documentation\n## Golden nuggets\n## Documentation use cases\n# The eight rules of good documentation\n# Fast understanding of your intentions\n# Diagrams and code visualization","[{\"question\":\"Why are consistent architecture diagrams important in C++ project documentation?\",\"answer\":\"They help express intentions precisely and support fast understanding across the team. Consistency also strengthens how documentation communicates architecture and code relationships.\"},{\"question\":\"What documentation principles are highlighted in the presentation?\",\"answer\":\"The presentation emphasizes clear and inviting writing, comprehensive coverage, skimmability, practical examples, repetition when useful, keeping content up to date, and making documentation easy to contribute to and find.\"},{\"question\":\"How does the approach relate diagrams to executable or maintainable artifacts?\",\"answer\":\"It focuses on “diagrams as code” and uses tooling concepts like repositories, build scripts, and versioning to keep diagrams integrated with the project’s documentation workflow.\"}]","Consistent architecture diagrams for C++ projects - Good documentation and diagram consistency | PDF",1792963473,93]