Abstract
Documentation plays a central role in Information Systems (IS) development and use. Software tools must be built to allow its automatic generation. In the same way as the need of prototyping for IS construction is generally accepted, so must be the need for “Documentation Prototyping”. In this paper a paradigm for the generation of documentation is proposed. It can be adapted to any IS development approach. In order to illustrate the proposed ideas, the Infolog approach was chosen in this paper.
On-line documentation is, in most cases, preferable to off-line one (the traditional paper manuals). The paradigm for generation of documentation herein proposed can be used to obtain both on-line and off-line documentation. Moreover, it is obtained in hypertext form for better browsing. The linearization of the hypertext network is also possible in order to produce the often required linear form (for example to obtain paper manuals).
The main contributions of this work are the generation paradigm, which uses the semantics of the modelling primitives in order to obtain natural language text fragments describing the specified models, and the generation of the “User Manual”, the more critical of the documents to be produced.
Chapter PDF
Keywords
These keywords were added by machine and not by the authors. This process is experimental and the keywords may be updated as the learning algorithm improves.
References
R. Carapuça, L. Andrade and A. Seraadas, “A Database Design and Construction Workbench”, in Computerized Assistance During the Information Systems Life Cycle, T.W. Olle, A.A. Verrijn-Stuart, L. Bhabuta (Eds), Elsevier Science Publishers B.V. (North-Holland), IFIP 1988
R. Carapuça et all., “Computer-Aided Database Development Tools: Extending the Caravela workbench”, ESPRIT project report, IACIS, April 1991
P. Chen, “The Entity-Relationship Model: Toward an Unified View of Data”, ACM TODS, 1:1, pp9–36, 1976
L. Jesus, “Geração Automática de Documentação para Sistemas de Informação”, MsC thesis, IST, October 1991
J. Nielsen, “Hypertext & Hypermedia”, Academic Press, Inc., 1990
J. Parkinson, “CASE — An Introduction, IBC Financial Books, 1989
A. Sernadas and C. Sernadas, “Infolog: An Integrated Model of Data and Processes”, IFIP WG8.1 Meeting, York, July 1983
A. Sernadas e C. Sernadas, “Infolog 86”, (in Portuguese) Revista de Informática, Vol. 5 Núm. 10, 1986
I. Sommerville, “Software Engineering”, Addison-Wesley Publishing Company, 1989
Author information
Authors and Affiliations
Editor information
Rights and permissions
Copyright information
© 1992 Springer-Verlag Berlin Heidelberg
About this paper
Cite this paper
Jesus, L., Carapuça, R. (1992). Automatic generation of documentation for information systems. In: Loucopoulos, P. (eds) Advanced Information Systems Engineering. CAiSE 1992. Lecture Notes in Computer Science, vol 593. Springer, Berlin, Heidelberg. https://doi.org/10.1007/BFb0035125
Download citation
DOI: https://doi.org/10.1007/BFb0035125
Published:
Publisher Name: Springer, Berlin, Heidelberg
Print ISBN: 978-3-540-55481-3
Online ISBN: 978-3-540-47099-1
eBook Packages: Springer Book Archive