skip to main content
10.1145/3270112.3270115acmconferencesArticle/Chapter ViewAbstractPublication PagesmodelsConference Proceedingsconference-collections
research-article

Documenting Simulink designs of embedded systems

Published: 14 October 2018 Publication History

Abstract

The importance of appropriate software design documentation has been well-established. Yet in industrial practice design documentation of large software systems is often out of date or entirely lacking in large part due to the effort required to produce and maintain useful design documents. While model-based design (mbd) partially addresses this problem, large complex models still require additional design documentation to enable development and maintenance. This paper introduces tool support for documenting the Software Design Description (sdd) of embedded systems developed using mbd with Simulink. In particular, the paper proposes a template for a sdd of a Simulink model. Then, the tool support we have developed for semi-automatic generation of sdds from the template is introduced. The tool support integrates MathWorks' Simulink Report Generator and our previously developed Signature Tool that identifies the interfaces of Simulink subsystems.

References

[1]
Andreas Rau. 2002. Integrated Specification and Documentation of SIMULINK Models. (2002). http://www.it-designers.info/uploads/media/iac2002.pdf International Automotive Conference.
[2]
Marc Bender, Karen Laurin, Mark Lawford, Vera Pantelic, Alexandre Korobkine, Jeff Ong, Bennett Mackenzie, Monika Bialy, and Steven Postma. 2015. Signature Required: Making Simulink Data Flow and Interfaces Explicit. Science of Computer Programming 113, Part 1 (2015), 29--50. Model Driven Development (Selected & extended papers from MODELSWARD 2014).
[3]
Adriana Pereira De Medeiros, Daniel Schwabe, and Bruno Feijó. 2005. Kuaba ontology: design rationale representation and reuse in model-based designs. In Conceptual Modeling-ER 2005. Springer, 241--255.
[4]
IEEE. 2009. IEEE Standard for Information Technology - Systems Design - Software Design Descriptions. IEEE Std 1016-2009 (Revision of IEEE Std 1016-1998) (July 2009), 1--58.
[5]
A. P. J. Jarczyk, P. Loffler, and F. M. Shipmann. 1992. Design rationale for software engineering: a survey. In Proceedings of the Twenty-Fifth Hawaii International Conference on System Sciences, Vol. ii. 577--586 vol.2.
[6]
Nancy Leveson. 2000. Intent specifications: an approach to building human-centered specifications. IEEE Transactions on Software Engineering 26, 1 (Jan 2000), 15--35.
[7]
Vera Pantelic, Steven Postma, Mark Lawford, Monika Jaskolka, Bennett Mackenzie, Alexandre Korobkine, Marc Bender, Jeff Ong, Gordon Marks, and Alan Wassyng. 2018. Software engineering practices and Simulink: bridging the gap. International Journal on Software Tools for Technology Transfer 20, 1 (01 Feb 2018), 95--117.
[8]
David Lorge Parnas. 2011. Precise Documentation: The Key to Better Software. Springer Berlin Heidelberg, Berlin, Heidelberg, 125--148.
[9]
David Lorge Parnas and Paul C. Clements. 1986. A rational design process: How and why to fake it. IEEE Transactions on Software Engineering 2 (1986), 251--257.
[10]
Ian Sommerville. 2001. Software documentation. Software Engineering 2 (2001), 143--154.

Cited By

View all
  • (2023)Repository mining for changes in Simulink and Stateflow modelsSoftware and Systems Modeling10.1007/s10270-023-01113-522:5(1713-1732)Online publication date: 16-Jun-2023
  • (2022)Combining Genetic Programming and Model Checking to Generate Environment AssumptionsIEEE Transactions on Software Engineering10.1109/TSE.2021.310181848:9(3664-3685)Online publication date: 1-Sep-2022
  • (2021)Repository Mining for Changes in Simulink Models2021 ACM/IEEE 24th International Conference on Model Driven Engineering Languages and Systems (MODELS)10.1109/MODELS50736.2021.00014(46-57)Online publication date: Oct-2021

Recommendations

Comments

Information & Contributors

Information

Published In

cover image ACM Conferences
MODELS '18: Proceedings of the 21st ACM/IEEE International Conference on Model Driven Engineering Languages and Systems: Companion Proceedings
October 2018
214 pages
Permission to make digital or hard copies of all or part of this work for personal or classroom use is granted without fee provided that copies are not made or distributed for profit or commercial advantage and that copies bear this notice and the full citation on the first page. Copyrights for components of this work owned by others than ACM must be honored. Abstracting with credit is permitted. To copy otherwise, or republish, to post on servers or to redistribute to lists, requires prior specific permission and/or a fee. Request permissions from [email protected]

Sponsors

In-Cooperation

  • IEEE CS

Publisher

Association for Computing Machinery

New York, NY, United States

Publication History

Published: 14 October 2018

Permissions

Request permissions for this article.

Check for updates

Author Tags

  1. matlab/simulink
  2. model-based design
  3. simulink report generator
  4. software design description
  5. software documentation
  6. tools

Qualifiers

  • Research-article

Conference

MODELS '18
Sponsor:

Acceptance Rates

MODELS '18 Paper Acceptance Rate 19 of 29 submissions, 66%;
Overall Acceptance Rate 144 of 506 submissions, 28%

Contributors

Other Metrics

Bibliometrics & Citations

Bibliometrics

Article Metrics

  • Downloads (Last 12 months)5
  • Downloads (Last 6 weeks)1
Reflects downloads up to 17 Feb 2025

Other Metrics

Citations

Cited By

View all
  • (2023)Repository mining for changes in Simulink and Stateflow modelsSoftware and Systems Modeling10.1007/s10270-023-01113-522:5(1713-1732)Online publication date: 16-Jun-2023
  • (2022)Combining Genetic Programming and Model Checking to Generate Environment AssumptionsIEEE Transactions on Software Engineering10.1109/TSE.2021.310181848:9(3664-3685)Online publication date: 1-Sep-2022
  • (2021)Repository Mining for Changes in Simulink Models2021 ACM/IEEE 24th International Conference on Model Driven Engineering Languages and Systems (MODELS)10.1109/MODELS50736.2021.00014(46-57)Online publication date: Oct-2021

View Options

Login options

View options

PDF

View or Download as a PDF file.

PDF

eReader

View online with eReader.

eReader

Figures

Tables

Media

Share

Share

Share this Publication link

Share on social media