Executable Documentation: Test-First in Action

Steven Smyth; Jette Petzold; Jonas Schürmann; Florian Karbus; Tiziana Margaria; Reinhard von Hanxleden; Bernhard Steffen

doi:10.1007/978-3-031-19756-7_8

Executable Documentation: Test-First in Action

Steven Smyth, Jette Petzold, Jonas Schürmann, Florian Karbus, Tiziana Margaria, Reinhard von Hanxleden, Bernhard Steffen

Research output: Chapter in Book/Report/Conference proceeding › Conference contribution › peer-review

Abstract

Regarding documentation as anything that supports understanding, we present two test-first scenarios of executable documentation that involve and support different roles during program development through concrete data visualizations. The first is a teaching scenario. Within classical programming, different stages of executable documentation provide faceted layers of self-learning and user-centric diagnostics. Students and teachers benefit from auto-didactic exploration, appropriate diagram syntheses for runtime visualization, and automated test case generation. The latter can be created using reference implementations provided by the teacher but can also be used to foster the dialog between students and tutors. The second scenario introduces a new approach to WYSIWYG GUI editing that is able to render the runtime GUI appearance in real-time within the editor. Using scenario-based test cases, users can seamlessly experience, inspect, and test the GUI while they are editing. The paper discusses the impact of the provided tangible experiences and their role in modern IDEs.

Original language	English
Title of host publication	Leveraging Applications of Formal Methods, Verification and Validation. Software Engineering - 11th International Symposium, ISoLA 2022, Proceedings
Editors	Tiziana Margaria, Bernhard Steffen
Publisher	Springer Science and Business Media Deutschland GmbH
Pages	135-156
Number of pages	22
ISBN (Print)	9783031197550
DOIs	https://doi.org/10.1007/978-3-031-19756-7_8
Publication status	Published - 2022
Event	11th International Symposium on Leveraging Applications of Formal Methods, Verification and Validation, ISoLA 2022 - Rhodes, Greece Duration: 22 Oct 2022 → 30 Oct 2022

Publication series

Name	Lecture Notes in Computer Science (including subseries Lecture Notes in Artificial Intelligence and Lecture Notes in Bioinformatics)
Volume	13702 LNCS
ISSN (Print)	0302-9743
ISSN (Electronic)	1611-3349

Conference

Conference	11th International Symposium on Leveraging Applications of Formal Methods, Verification and Validation, ISoLA 2022
Country/Territory	Greece
City	Rhodes
Period	22/10/22 → 30/10/22

Keywords

Automatic layout
Documentation
Teaching
Test-driven development
Verification
Web technologies

Access to Document

10.1007/978-3-031-19756-7_8

Cite this

Smyth, S., Petzold, J., Schürmann, J., Karbus, F., Margaria, T., von Hanxleden, R., & Steffen, B. (2022). Executable Documentation: Test-First in Action. In T. Margaria, & B. Steffen (Eds.), Leveraging Applications of Formal Methods, Verification and Validation. Software Engineering - 11th International Symposium, ISoLA 2022, Proceedings (pp. 135-156). (Lecture Notes in Computer Science (including subseries Lecture Notes in Artificial Intelligence and Lecture Notes in Bioinformatics); Vol. 13702 LNCS). Springer Science and Business Media Deutschland GmbH. https://doi.org/10.1007/978-3-031-19756-7_8

Smyth, Steven ; Petzold, Jette ; Schürmann, Jonas et al. / Executable Documentation : Test-First in Action. Leveraging Applications of Formal Methods, Verification and Validation. Software Engineering - 11th International Symposium, ISoLA 2022, Proceedings. editor / Tiziana Margaria ; Bernhard Steffen. Springer Science and Business Media Deutschland GmbH, 2022. pp. 135-156 (Lecture Notes in Computer Science (including subseries Lecture Notes in Artificial Intelligence and Lecture Notes in Bioinformatics)).

@inproceedings{53eade0ef5a344c2b1b14aba51940406,

title = "Executable Documentation: Test-First in Action",

abstract = "Regarding documentation as anything that supports understanding, we present two test-first scenarios of executable documentation that involve and support different roles during program development through concrete data visualizations. The first is a teaching scenario. Within classical programming, different stages of executable documentation provide faceted layers of self-learning and user-centric diagnostics. Students and teachers benefit from auto-didactic exploration, appropriate diagram syntheses for runtime visualization, and automated test case generation. The latter can be created using reference implementations provided by the teacher but can also be used to foster the dialog between students and tutors. The second scenario introduces a new approach to WYSIWYG GUI editing that is able to render the runtime GUI appearance in real-time within the editor. Using scenario-based test cases, users can seamlessly experience, inspect, and test the GUI while they are editing. The paper discusses the impact of the provided tangible experiences and their role in modern IDEs.",

keywords = "Automatic layout, Documentation, Teaching, Test-driven development, Verification, Web technologies",

author = "Steven Smyth and Jette Petzold and Jonas Sch{\"u}rmann and Florian Karbus and Tiziana Margaria and {von Hanxleden}, Reinhard and Bernhard Steffen",

note = "Publisher Copyright: {\textcopyright} 2022, The Author(s), under exclusive license to Springer Nature Switzerland AG.; 11th International Symposium on Leveraging Applications of Formal Methods, Verification and Validation, ISoLA 2022 ; Conference date: 22-10-2022 Through 30-10-2022",

year = "2022",

doi = "10.1007/978-3-031-19756-7_8",

language = "English",

isbn = "9783031197550",

series = "Lecture Notes in Computer Science (including subseries Lecture Notes in Artificial Intelligence and Lecture Notes in Bioinformatics)",

publisher = "Springer Science and Business Media Deutschland GmbH",

pages = "135--156",

editor = "Tiziana Margaria and Bernhard Steffen",

booktitle = "Leveraging Applications of Formal Methods, Verification and Validation. Software Engineering - 11th International Symposium, ISoLA 2022, Proceedings",

}

Smyth, S, Petzold, J, Schürmann, J, Karbus, F, Margaria, T, von Hanxleden, R & Steffen, B 2022, Executable Documentation: Test-First in Action. in T Margaria & B Steffen (eds), Leveraging Applications of Formal Methods, Verification and Validation. Software Engineering - 11th International Symposium, ISoLA 2022, Proceedings. Lecture Notes in Computer Science (including subseries Lecture Notes in Artificial Intelligence and Lecture Notes in Bioinformatics), vol. 13702 LNCS, Springer Science and Business Media Deutschland GmbH, pp. 135-156, 11th International Symposium on Leveraging Applications of Formal Methods, Verification and Validation, ISoLA 2022, Rhodes, Greece, 22/10/22. https://doi.org/10.1007/978-3-031-19756-7_8

Executable Documentation: Test-First in Action. / Smyth, Steven; Petzold, Jette; Schürmann, Jonas et al.
Leveraging Applications of Formal Methods, Verification and Validation. Software Engineering - 11th International Symposium, ISoLA 2022, Proceedings. ed. / Tiziana Margaria; Bernhard Steffen. Springer Science and Business Media Deutschland GmbH, 2022. p. 135-156 (Lecture Notes in Computer Science (including subseries Lecture Notes in Artificial Intelligence and Lecture Notes in Bioinformatics); Vol. 13702 LNCS).

Research output: Chapter in Book/Report/Conference proceeding › Conference contribution › peer-review

TY - GEN

T1 - Executable Documentation

T2 - 11th International Symposium on Leveraging Applications of Formal Methods, Verification and Validation, ISoLA 2022

AU - Smyth, Steven

AU - Petzold, Jette

AU - Schürmann, Jonas

AU - Karbus, Florian

AU - Margaria, Tiziana

AU - von Hanxleden, Reinhard

AU - Steffen, Bernhard

PY - 2022

Y1 - 2022

N2 - Regarding documentation as anything that supports understanding, we present two test-first scenarios of executable documentation that involve and support different roles during program development through concrete data visualizations. The first is a teaching scenario. Within classical programming, different stages of executable documentation provide faceted layers of self-learning and user-centric diagnostics. Students and teachers benefit from auto-didactic exploration, appropriate diagram syntheses for runtime visualization, and automated test case generation. The latter can be created using reference implementations provided by the teacher but can also be used to foster the dialog between students and tutors. The second scenario introduces a new approach to WYSIWYG GUI editing that is able to render the runtime GUI appearance in real-time within the editor. Using scenario-based test cases, users can seamlessly experience, inspect, and test the GUI while they are editing. The paper discusses the impact of the provided tangible experiences and their role in modern IDEs.

AB - Regarding documentation as anything that supports understanding, we present two test-first scenarios of executable documentation that involve and support different roles during program development through concrete data visualizations. The first is a teaching scenario. Within classical programming, different stages of executable documentation provide faceted layers of self-learning and user-centric diagnostics. Students and teachers benefit from auto-didactic exploration, appropriate diagram syntheses for runtime visualization, and automated test case generation. The latter can be created using reference implementations provided by the teacher but can also be used to foster the dialog between students and tutors. The second scenario introduces a new approach to WYSIWYG GUI editing that is able to render the runtime GUI appearance in real-time within the editor. Using scenario-based test cases, users can seamlessly experience, inspect, and test the GUI while they are editing. The paper discusses the impact of the provided tangible experiences and their role in modern IDEs.

KW - Automatic layout

KW - Documentation

KW - Teaching

KW - Test-driven development

KW - Verification

KW - Web technologies

UR - http://www.scopus.com/inward/record.url?scp=85142761063&partnerID=8YFLogxK

U2 - 10.1007/978-3-031-19756-7_8

DO - 10.1007/978-3-031-19756-7_8

M3 - Conference contribution

AN - SCOPUS:85142761063

SN - 9783031197550

T3 - Lecture Notes in Computer Science (including subseries Lecture Notes in Artificial Intelligence and Lecture Notes in Bioinformatics)

SP - 135

EP - 156

BT - Leveraging Applications of Formal Methods, Verification and Validation. Software Engineering - 11th International Symposium, ISoLA 2022, Proceedings

A2 - Margaria, Tiziana

A2 - Steffen, Bernhard

PB - Springer Science and Business Media Deutschland GmbH

Y2 - 22 October 2022 through 30 October 2022

ER -

Smyth S, Petzold J, Schürmann J, Karbus F, Margaria T, von Hanxleden R et al. Executable Documentation: Test-First in Action. In Margaria T, Steffen B, editors, Leveraging Applications of Formal Methods, Verification and Validation. Software Engineering - 11th International Symposium, ISoLA 2022, Proceedings. Springer Science and Business Media Deutschland GmbH. 2022. p. 135-156. (Lecture Notes in Computer Science (including subseries Lecture Notes in Artificial Intelligence and Lecture Notes in Bioinformatics)). doi: 10.1007/978-3-031-19756-7_8