Software Specification and Documentation in Continuous Software Development: A Focus Group Report

Uwe van Heesch, Theo Theunissen, O. Zimmermann, Uwe Zdun
{"title":"Software Specification and Documentation in Continuous Software Development: A Focus Group Report","authors":"Uwe van Heesch, Theo Theunissen, O. Zimmermann, Uwe Zdun","doi":"10.1145/3147704.3147742","DOIUrl":null,"url":null,"abstract":"We have been observing an ongoing trend in the software engineering domain towards development practices that rely heavily on verbal communication and small, closely-interacting teams. Among others, approaches like Scrum, Lean Software Development, and DevOps fall under this category. We refer to such development practices as Continuous Software Development (ConSD). Some core principles of ConSD are working in short iterations with frequent delivery, striving for an optimal balance between effectiveness and efficiency, and amplify learning in the development team. In such a context, many traditional patterns of software specification, documentation and knowledge preservation are not applicable anymore. To explore relevant topics, opinions, challenges and chances around specification, documentation and knowledge preservation in ConSD, we conducted a workshop at the 22nd European Conference on Pattern Languages of Programs (EuroPLoP), held in Germany in July 2017. The workshop participants came from the industry and academia. In this report, we present the results of the workshop. Among others, we elaborate on the difference between specification and documentation, the special role of architecture in ConSD in general, and architecture decision documentation in particular, and the importance of tooling that combines aspects of development, project management, and quality assurance. Furthermore, we describe typical issues with documentation and identify means to efficiently and effectively organize specification and documentation tasks in ConSD.","PeriodicalId":171324,"journal":{"name":"Proceedings of the 22nd European Conference on Pattern Languages of Programs","volume":"7 1","pages":"0"},"PeriodicalIF":0.0000,"publicationDate":"2017-07-12","publicationTypes":"Journal Article","fieldsOfStudy":null,"isOpenAccess":false,"openAccessPdf":"","citationCount":"9","resultStr":null,"platform":"Semanticscholar","paperid":null,"PeriodicalName":"Proceedings of the 22nd European Conference on Pattern Languages of Programs","FirstCategoryId":"1085","ListUrlMain":"https://doi.org/10.1145/3147704.3147742","RegionNum":0,"RegionCategory":null,"ArticlePicture":[],"TitleCN":null,"AbstractTextCN":null,"PMCID":null,"EPubDate":"","PubModel":"","JCR":"","JCRName":"","Score":null,"Total":0}
引用次数: 9

Abstract

We have been observing an ongoing trend in the software engineering domain towards development practices that rely heavily on verbal communication and small, closely-interacting teams. Among others, approaches like Scrum, Lean Software Development, and DevOps fall under this category. We refer to such development practices as Continuous Software Development (ConSD). Some core principles of ConSD are working in short iterations with frequent delivery, striving for an optimal balance between effectiveness and efficiency, and amplify learning in the development team. In such a context, many traditional patterns of software specification, documentation and knowledge preservation are not applicable anymore. To explore relevant topics, opinions, challenges and chances around specification, documentation and knowledge preservation in ConSD, we conducted a workshop at the 22nd European Conference on Pattern Languages of Programs (EuroPLoP), held in Germany in July 2017. The workshop participants came from the industry and academia. In this report, we present the results of the workshop. Among others, we elaborate on the difference between specification and documentation, the special role of architecture in ConSD in general, and architecture decision documentation in particular, and the importance of tooling that combines aspects of development, project management, and quality assurance. Furthermore, we describe typical issues with documentation and identify means to efficiently and effectively organize specification and documentation tasks in ConSD.
持续软件开发中的软件规范和文档:焦点小组报告
我们一直在观察软件工程领域中一个正在进行的趋势,即开发实践严重依赖于口头交流和小型的、紧密交互的团队。在其他方法中,像Scrum、精益软件开发和DevOps都属于这一类。我们将这样的开发实践称为持续软件开发(ConSD)。ConSD的一些核心原则是在频繁交付的短迭代中工作,努力在有效性和效率之间取得最佳平衡,并扩大开发团队的学习。在这种情况下,许多传统的软件规范、文档和知识保存模式不再适用。为了探讨ConSD中规范、文档和知识保存的相关主题、意见、挑战和机遇,我们在2017年7月在德国举行的第22届欧洲程序模式语言会议(EuroPLoP)上举办了一个研讨会。工作坊参加者来自业界及学术界。在本报告中,我们介绍了研讨会的成果。其中,我们详细说明了规范和文档之间的区别,架构在ConSD中的特殊作用,特别是架构决策文档,以及结合开发、项目管理和质量保证方面的工具的重要性。此外,我们描述了文档的典型问题,并确定了在ConSD中有效地组织规范和文档任务的方法。
本文章由计算机程序翻译,如有差异,请以英文原文为准。
求助全文
约1分钟内获得全文 求助全文
来源期刊
自引率
0.00%
发文量
0
×
引用
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学术文献互助群
群 号:481959085
Book学术官方微信