Abstract
In software engineering, documentation and models are both broad concepts which attract varying approaches and attitudes. Moreover, as the title indicates, they overlap: in some circumstances, an artefact thought of as a model can serve to document a software project, while in others, an artefact thought of as a document can be manipulated by model-driven engineering tools just like any other kind of model. In this short paper we briefly explore these issues and provide pointers to some of the relevant literature.
Keywords
- Documentation
- Programming
- Modelling
This is a preview of subscription content, access via your institution.
Buying options
Notes
References
Aghajani, E., et al.: Software documentation: the practitioners’ perspective. In: Rothermel, G., Bae, D.-H. (eds.) ICSE 2020: 42nd International Conference on Software Engineering, Seoul, South Korea, June 27 - July 19 2020, pp. 590–601. ACM (2020)
Anderson, T., Quach, K.: GitHub copilot auto-coder snags emerge, from seemingly spilled secrets to bad code, but some love it. https://www.theregister.com/2021/07/06/github_copilot_autocoder_caught_spilling/ (2021)
Camilleri, J.J., Schneider, G.: Modelling and analysis of normative documents. J. Log. Algebraic Methods Program. 91, 33–59 (2017)
Chen, P.P.: The entity-relationship model - toward a unified view of data. ACM Trans. Database Syst. 1(1), 9–36 (1976)
Cybersprint: Swagger API: discovery of API data and security flaws. https://www.cybersprint.com/blog/swagger-api-discovery-of-api-data-and-security-flaws (2020)
Daniels, J.: Modeling with a sense of purpose. IEEE Softw. 19(1), 8–10 (2002)
de Jong, M., et al.: Terms of service; didn’t read. https://tosdr.org/ (2011)
Ericsson, M., Wingkvist, A., Löwe, W.: The design and implementation of a software infrastructure for IQ assessment. Int. J. Inf. Qual. 3(1), 49–70 (2012)
Fowler, M.: UmlAsBlueprint. https://martinfowler.com/bliki/UmlAsBlueprint.html (2003)
Fowler, M.: UmlMode. https://martinfowler.com/bliki/UmlMode.html (2003)
Howard, J.: Is github copilot a blessing, or a curse? https://www.fast.ai/2021/07/19/copilot/ (2021)
Ralphson, M.: What we learned from 200,000 OpenAPI files. https://blog.postman.com/what-we-learned-from-200000-openapi-files/ (2021)
Sferruzza, D.: Plateforme extensible de modélisation et de construction d’applications web correctes et évolutives, avec hypothèse de variabilité. (Towards an extensible framework for modelling and implementing correct and evolutive web applications, under variability hypothesis), Ph. D thesis, University of Nantes, France (2018)
Sferruzza, D.: Top-down model-driven engineering of web services from extended OpenAPI models. In: Huchard, M., Kästner, C., Fraser, G. (eds.) Proceedings of the 33rd ACM/IEEE International Conference on Automated Software Engineering, ASE 2018, Montpellier, France, 3–7 September 2018, pp. 940–943. ACM (2018)
Steffen, B., Gossen, F., Naujokat, S., Margaria, T.: Language-driven engineering: from general-purpose to purpose-specific languages. In: Steffen, B., Woeginger, G. (eds.) Computing and Software Science. LNCS, vol. 10000, pp. 311–344. Springer, Cham (2019). https://doi.org/10.1007/978-3-319-91908-9_17
Wilson, S., et al.: The creation and analysis of a website privacy policy corpus. In: Proceedings of the 54th Annual Meeting of the Association for Computational Linguistics, ACL 2016, 7–12 August 2016, Berlin, Germany, vol. 1: Long Papers. The Association for Computer Linguistics (2016)
Zurcher, F.W., Randell, B.: Iterative multi-level modelling. a methodology for computer system design. In: Morrel, A.J.H., (ed.) Information Processing, Proceedings of IFIP Congress 1968, Edinburgh, UK, 5–10 August 1968, vol. 2 - Hardware, Applications, pp. 867–871 (1968)
Acknowledgements
I thank the anonymous reviewers for insightful comments, questions and pointers to relevant literature.
Author information
Authors and Affiliations
Corresponding author
Editor information
Editors and Affiliations
Rights and permissions
Copyright information
© 2022 The Author(s), under exclusive license to Springer Nature Switzerland AG
About this paper
Cite this paper
Stevens, P. (2022). Models as Documents, Documents as Models. In: Margaria, T., Steffen, B. (eds) Leveraging Applications of Formal Methods, Verification and Validation. Software Engineering. ISoLA 2022. Lecture Notes in Computer Science, vol 13702. Springer, Cham. https://doi.org/10.1007/978-3-031-19756-7_3
Download citation
DOI: https://doi.org/10.1007/978-3-031-19756-7_3
Published:
Publisher Name: Springer, Cham
Print ISBN: 978-3-031-19755-0
Online ISBN: 978-3-031-19756-7
eBook Packages: Computer ScienceComputer Science (R0)