软件架构与非正式文档的一致性检验

Jan Keim, A. Koziolek
{"title":"软件架构与非正式文档的一致性检验","authors":"Jan Keim, A. Koziolek","doi":"10.1109/ICSA-C.2019.00052","DOIUrl":null,"url":null,"abstract":"In the development process, documenting the software architecture is important to capture all reasoning and design decisions. Without a good and complete documentation, there is a lot of tacit knowledge that easily can get lost resulting in threats for success and increased costs. However, software architecture documentation is often missing or outdated. One reason for it is the tedious and costly process of creating and updating documentation in comparison to (perceived) low benefits. In this paper, we first present our long-term vision, where all information from any sources are persisted to avoid losing crucial information about a system. A base problem in this vision is keeping information from different sources consistent, with a major challenge of keeping consistency between models and informal documentation. We plan to address checking the consistency between models and textual natural language artefacts using natural language understanding. For this, we plan to break down the task into smaller subtasks that should provide a better understanding of the documents and their semantics. The extracted information should then be used to create traceability links and to check whether statements within the textual documentation are consistent with the software architecture models.","PeriodicalId":239999,"journal":{"name":"2019 IEEE International Conference on Software Architecture Companion (ICSA-C)","volume":"17 1","pages":"0"},"PeriodicalIF":0.0000,"publicationDate":"2019-03-25","publicationTypes":"Journal Article","fieldsOfStudy":null,"isOpenAccess":false,"openAccessPdf":"","citationCount":"15","resultStr":"{\"title\":\"Towards Consistency Checking Between Software Architecture and Informal Documentation\",\"authors\":\"Jan Keim, A. Koziolek\",\"doi\":\"10.1109/ICSA-C.2019.00052\",\"DOIUrl\":null,\"url\":null,\"abstract\":\"In the development process, documenting the software architecture is important to capture all reasoning and design decisions. Without a good and complete documentation, there is a lot of tacit knowledge that easily can get lost resulting in threats for success and increased costs. However, software architecture documentation is often missing or outdated. One reason for it is the tedious and costly process of creating and updating documentation in comparison to (perceived) low benefits. In this paper, we first present our long-term vision, where all information from any sources are persisted to avoid losing crucial information about a system. A base problem in this vision is keeping information from different sources consistent, with a major challenge of keeping consistency between models and informal documentation. We plan to address checking the consistency between models and textual natural language artefacts using natural language understanding. For this, we plan to break down the task into smaller subtasks that should provide a better understanding of the documents and their semantics. The extracted information should then be used to create traceability links and to check whether statements within the textual documentation are consistent with the software architecture models.\",\"PeriodicalId\":239999,\"journal\":{\"name\":\"2019 IEEE International Conference on Software Architecture Companion (ICSA-C)\",\"volume\":\"17 1\",\"pages\":\"0\"},\"PeriodicalIF\":0.0000,\"publicationDate\":\"2019-03-25\",\"publicationTypes\":\"Journal Article\",\"fieldsOfStudy\":null,\"isOpenAccess\":false,\"openAccessPdf\":\"\",\"citationCount\":\"15\",\"resultStr\":null,\"platform\":\"Semanticscholar\",\"paperid\":null,\"PeriodicalName\":\"2019 IEEE International Conference on Software Architecture Companion (ICSA-C)\",\"FirstCategoryId\":\"1085\",\"ListUrlMain\":\"https://doi.org/10.1109/ICSA-C.2019.00052\",\"RegionNum\":0,\"RegionCategory\":null,\"ArticlePicture\":[],\"TitleCN\":null,\"AbstractTextCN\":null,\"PMCID\":null,\"EPubDate\":\"\",\"PubModel\":\"\",\"JCR\":\"\",\"JCRName\":\"\",\"Score\":null,\"Total\":0}","platform":"Semanticscholar","paperid":null,"PeriodicalName":"2019 IEEE International Conference on Software Architecture Companion (ICSA-C)","FirstCategoryId":"1085","ListUrlMain":"https://doi.org/10.1109/ICSA-C.2019.00052","RegionNum":0,"RegionCategory":null,"ArticlePicture":[],"TitleCN":null,"AbstractTextCN":null,"PMCID":null,"EPubDate":"","PubModel":"","JCR":"","JCRName":"","Score":null,"Total":0}
引用次数: 15

摘要

在开发过程中,记录软件体系结构对于捕获所有推理和设计决策非常重要。如果没有良好和完整的文档,就会有很多隐性知识很容易丢失,从而威胁到成功并增加成本。然而,软件架构文档经常缺失或过时。其中一个原因是创建和更新文档的过程冗长而昂贵,相比之下(人们认为)收益很低。在本文中,我们首先展示了我们的长期愿景,其中来自任何来源的所有信息都被持久化,以避免丢失关于系统的关键信息。这个观点中的一个基本问题是保持来自不同来源的信息的一致性,主要挑战是保持模型和非正式文档之间的一致性。我们计划使用自然语言理解来检查模型和文本自然语言工件之间的一致性。为此,我们计划将任务分解为更小的子任务,以便更好地理解文档及其语义。然后应该使用提取的信息来创建可跟踪性链接,并检查文本文档中的语句是否与软件体系结构模型一致。
本文章由计算机程序翻译,如有差异,请以英文原文为准。
查看原文
分享 分享
微信好友 朋友圈 QQ好友 复制链接
本刊更多论文
Towards Consistency Checking Between Software Architecture and Informal Documentation
In the development process, documenting the software architecture is important to capture all reasoning and design decisions. Without a good and complete documentation, there is a lot of tacit knowledge that easily can get lost resulting in threats for success and increased costs. However, software architecture documentation is often missing or outdated. One reason for it is the tedious and costly process of creating and updating documentation in comparison to (perceived) low benefits. In this paper, we first present our long-term vision, where all information from any sources are persisted to avoid losing crucial information about a system. A base problem in this vision is keeping information from different sources consistent, with a major challenge of keeping consistency between models and informal documentation. We plan to address checking the consistency between models and textual natural language artefacts using natural language understanding. For this, we plan to break down the task into smaller subtasks that should provide a better understanding of the documents and their semantics. The extracted information should then be used to create traceability links and to check whether statements within the textual documentation are consistent with the software architecture models.
求助全文
通过发布文献求助,成功后即可免费获取论文全文。 去求助
来源期刊
自引率
0.00%
发文量
0
期刊最新文献
A Retargetable Fault Injection Framework for Safety Validation of Autonomous Vehicles Experience Report: Combining Mixed-Criticality Support with Resource Reservation and Spare Capacity Allocation DecidArch V2: An Improved Game to Teach Architecture Design Decision Making Towards Consistency Checking Between Software Architecture and Informal Documentation Machine Learning System Architectural Pattern for Improving Operational Stability
×
引用
GB/T 7714-2015
复制
MLA
复制
APA
复制
导出至
BibTeX EndNote RefMan NoteFirst NoteExpress
×
×
提示
您的信息不完整,为了账户安全,请先补充。
现在去补充
×
提示
您因"违规操作"
具体请查看互助需知
我知道了
×
提示
现在去查看 取消
×
提示
确定
0
微信
客服QQ
Book学术公众号 扫码关注我们
反馈
×
意见反馈
请填写您的意见或建议
请填写您的手机或邮箱
已复制链接
已复制链接
快去分享给好友吧!
我知道了
×
扫码分享
扫码分享
Book学术官方微信
Book学术文献互助
Book学术文献互助群
群 号:481959085
Book学术
文献互助 智能选刊 最新文献 互助须知 联系我们:info@booksci.cn
Book学术提供免费学术资源搜索服务,方便国内外学者检索中英文文献。致力于提供最便捷和优质的服务体验。
Copyright © 2023 Book学术 All rights reserved.
ghs 京公网安备 11010802042870号 京ICP备2023020795号-1