汽车系统/软件工程中作为代码的文档

IF 0.9 4区 工程技术 Q4 ENGINEERING, ELECTRICAL & ELECTRONIC
Momcilo Krunic
{"title":"汽车系统/软件工程中作为代码的文档","authors":"Momcilo Krunic","doi":"10.5755/j02.eie.33843","DOIUrl":null,"url":null,"abstract":"Documentation as Code (DaC) is an approach that applies the principles of software development to the production of technical documentation. Using modern tools, DaC enables software engineers to treat documentation as a first-class citizen in the development process, alongside code and tests. In this paper, we discuss the advantages of DaC in system and software engineering, including improved accuracy, traceability, and maintainability. In the automotive industry, DaC has been used to document various aspects of vehicle development, such as requirements, design, testing, and compliance. This paper provides an overview of the state-of-the-art in DaC in the automotive industry and discusses the potential benefits and challenges of using this approach. In addition, case studies and examples of how DaC has been used in the automotive industry to improve the quality and maintainability of documentation are presented. This research has been conducted with more than 150 engineers actively contributing to DaC on the project for more than a year within a company, so the scalability of the presented solution has been tested. Finally, a set of guidelines is provided for teams to follow when adopting DaC to ensure successful implementation.","PeriodicalId":51031,"journal":{"name":"Elektronika Ir Elektrotechnika","volume":" ","pages":""},"PeriodicalIF":0.9000,"publicationDate":"2023-09-07","publicationTypes":"Journal Article","fieldsOfStudy":null,"isOpenAccess":false,"openAccessPdf":"","citationCount":"0","resultStr":"{\"title\":\"Documentation as Code in Automotive System/Software Engineering\",\"authors\":\"Momcilo Krunic\",\"doi\":\"10.5755/j02.eie.33843\",\"DOIUrl\":null,\"url\":null,\"abstract\":\"Documentation as Code (DaC) is an approach that applies the principles of software development to the production of technical documentation. Using modern tools, DaC enables software engineers to treat documentation as a first-class citizen in the development process, alongside code and tests. In this paper, we discuss the advantages of DaC in system and software engineering, including improved accuracy, traceability, and maintainability. In the automotive industry, DaC has been used to document various aspects of vehicle development, such as requirements, design, testing, and compliance. This paper provides an overview of the state-of-the-art in DaC in the automotive industry and discusses the potential benefits and challenges of using this approach. In addition, case studies and examples of how DaC has been used in the automotive industry to improve the quality and maintainability of documentation are presented. This research has been conducted with more than 150 engineers actively contributing to DaC on the project for more than a year within a company, so the scalability of the presented solution has been tested. Finally, a set of guidelines is provided for teams to follow when adopting DaC to ensure successful implementation.\",\"PeriodicalId\":51031,\"journal\":{\"name\":\"Elektronika Ir Elektrotechnika\",\"volume\":\" \",\"pages\":\"\"},\"PeriodicalIF\":0.9000,\"publicationDate\":\"2023-09-07\",\"publicationTypes\":\"Journal Article\",\"fieldsOfStudy\":null,\"isOpenAccess\":false,\"openAccessPdf\":\"\",\"citationCount\":\"0\",\"resultStr\":null,\"platform\":\"Semanticscholar\",\"paperid\":null,\"PeriodicalName\":\"Elektronika Ir Elektrotechnika\",\"FirstCategoryId\":\"5\",\"ListUrlMain\":\"https://doi.org/10.5755/j02.eie.33843\",\"RegionNum\":4,\"RegionCategory\":\"工程技术\",\"ArticlePicture\":[],\"TitleCN\":null,\"AbstractTextCN\":null,\"PMCID\":null,\"EPubDate\":\"\",\"PubModel\":\"\",\"JCR\":\"Q4\",\"JCRName\":\"ENGINEERING, ELECTRICAL & ELECTRONIC\",\"Score\":null,\"Total\":0}","platform":"Semanticscholar","paperid":null,"PeriodicalName":"Elektronika Ir Elektrotechnika","FirstCategoryId":"5","ListUrlMain":"https://doi.org/10.5755/j02.eie.33843","RegionNum":4,"RegionCategory":"工程技术","ArticlePicture":[],"TitleCN":null,"AbstractTextCN":null,"PMCID":null,"EPubDate":"","PubModel":"","JCR":"Q4","JCRName":"ENGINEERING, ELECTRICAL & ELECTRONIC","Score":null,"Total":0}
引用次数: 0

摘要

代码文档(DaC)是一种将软件开发原则应用于技术文档制作的方法。使用现代工具,DaC使软件工程师能够在开发过程中将文档与代码和测试一起视为一流的公民。在本文中,我们讨论了DaC在系统和软件工程中的优势,包括提高准确性、可追溯性和可维护性。在汽车行业,DaC已被用于记录车辆开发的各个方面,如需求、设计、测试和合规性。本文概述了汽车行业DaC的最新技术,并讨论了使用这种方法的潜在好处和挑战。此外,还介绍了DaC如何在汽车行业中用于提高文档质量和可维护性的案例研究和示例。这项研究是由150多名工程师在一家公司内为DaC项目积极贡献了一年多的时间进行的,因此所提出的解决方案的可扩展性已经得到了测试。最后,提供了一套指导方针,供团队在采用DaC时遵循,以确保成功实施。
本文章由计算机程序翻译,如有差异,请以英文原文为准。
Documentation as Code in Automotive System/Software Engineering
Documentation as Code (DaC) is an approach that applies the principles of software development to the production of technical documentation. Using modern tools, DaC enables software engineers to treat documentation as a first-class citizen in the development process, alongside code and tests. In this paper, we discuss the advantages of DaC in system and software engineering, including improved accuracy, traceability, and maintainability. In the automotive industry, DaC has been used to document various aspects of vehicle development, such as requirements, design, testing, and compliance. This paper provides an overview of the state-of-the-art in DaC in the automotive industry and discusses the potential benefits and challenges of using this approach. In addition, case studies and examples of how DaC has been used in the automotive industry to improve the quality and maintainability of documentation are presented. This research has been conducted with more than 150 engineers actively contributing to DaC on the project for more than a year within a company, so the scalability of the presented solution has been tested. Finally, a set of guidelines is provided for teams to follow when adopting DaC to ensure successful implementation.
求助全文
通过发布文献求助,成功后即可免费获取论文全文。 去求助
来源期刊
Elektronika Ir Elektrotechnika
Elektronika Ir Elektrotechnika 工程技术-工程:电子与电气
CiteScore
2.40
自引率
7.70%
发文量
44
审稿时长
24 months
期刊介绍: The journal aims to attract original research papers on featuring practical developments in the field of electronics and electrical engineering. The journal seeks to publish research progress in the field of electronics and electrical engineering with an emphasis on the applied rather than the theoretical in as much detail as possible. The journal publishes regular papers dealing with the following areas, but not limited to: Electronics; Electronic Measurements; Signal Technology; Microelectronics; High Frequency Technology, Microwaves. Electrical Engineering; Renewable Energy; Automation, Robotics; Telecommunications Engineering.
×
引用
GB/T 7714-2015
复制
MLA
复制
APA
复制
导出至
BibTeX EndNote RefMan NoteFirst NoteExpress
×
提示
您的信息不完整,为了账户安全,请先补充。
现在去补充
×
提示
您因"违规操作"
具体请查看互助需知
我知道了
×
提示
确定
请完成安全验证×
copy
已复制链接
快去分享给好友吧!
我知道了
右上角分享
点击右上角分享
0
联系我们:info@booksci.cn Book学术提供免费学术资源搜索服务,方便国内外学者检索中英文文献。致力于提供最便捷和优质的服务体验。 Copyright © 2023 布克学术 All rights reserved.
京ICP备2023020795号-1
ghs 京公网安备 11010802042870号
Book学术文献互助
Book学术文献互助群
群 号:604180095
Book学术官方微信