WebMLDoc: An approach for changes detection and traceability in user manuals for Web-applications

D. V. Koznov ; M. N. Smirnov ; V. A. Dorokhov ; K. Yu. Romanovsky

Vestnik Sankt-Peterburgskogo universiteta. Prikladnaâ matematika, informatika, processy upravleniâ, no. 3 (2011), pp. 112-126

Résumé

A well-known problem of automated maintenance of software user documentation during software product evolution is considered. WebMLDoc approach to solve this problem in Web-application domain is introduced. We use a model-oriented paradigm that implies generation of a source code for the main part of software or even from all models and further modifications of application via model modifications and code regeneration. In this case it is possible to “link” documentation with models not with a source code itself. This is much more convenient because models contain high-level information about an application code. This “link” is used for automated controlling documentation topics which are to be changed in accordance with software changes. In this paper a hypertext model of WebML modeling language is used. This model describes user interface features and is reflected to user documentation very well. We also present a pilot implementation of the approach.

Détail

Keywords: software documentation, model-based development
Mots-clés : Web-applications, hypertext model, WebML, DocLine.

Bibliographie

[1] Putrycz E., Kark A. W., “Connecting Legacy Code, Business Rules and Documentation”, RuleML 2008, LNCS, 5321, Springer-Verlag, Berlin; Heidelberg, 2008, 17–30

[2] Pierce R., Tilley S, “Automatically Connecting Documentation to Code with Rose”, SIGDOC'02 (October 20–23. Toronto, Ontario, Canada), ACM, 2002, 1-58113-543-2/02/0010, 7 pp.

[3] Wang X., Lai G., Liu C., “Recovering Relationships between Documentation and Source Code Based on the Characteristics of Software Engineering”, Electronic Notes in Theoretical Computer Science. Elsevier B.V., 2009, 121–137 | DOI

[4] Childs B., Sametinger J., “Literate Programming and Documentation Reuse”, Proc. Fourth Intern. Conference on Software Reuse, 1996, 205–214 | DOI

[5] Valderas P., Pelechano V., “Introducing Requirements Traceability Support in Model-Driven Development of Web Applications”, Information and Software Technology J., 51:4 (2009), 749–768 | DOI

[6] Hollings D., Sharpey-Schafer K., Kelleher J., Representing Software Traceability using UML and XTM with an investigation into Traceability Patterns, Honours Project, 2005

[7] Schwabe D., Rossi G., “An Object Oriented Approach to Web-Based Application Design”, Theory and Practice of Object Systems, 4:4 (1998), 207–225 | 3.0.CO;2-2 class='badge bg-secondary rounded-pill ref-badge extid-badge'>DOI

[8] “UWA Consortium. The UWA Approach to Modeling Ubiquitous Web Applications”, IST Mobile Wireless Telecommunications Summit (Greece, June, 2002), 1–6

[9] De Troyer O. M. F., Leune C. J., “WSDM: A User Centered Design Method for Web Sites”, Proc. of the 7th Intern. World Wide Web Conference, Elsevier, 1998, 85–94

[10] Knapp A., Koch N., Zhang G., Hassler H., “Modeling Business Processes inWeb Applications with ArgoUWE”, UML 2004, LNCS, 3273, Springer-Verlag, Berlin; Heidelberg, 2004, 69–83

[11] Fons J., Pelechano V., Albert M., Pastor O., “Development of Web Applications from Web Enhanced Conceptual Schemas”, Proc. of the 22th Intern. Conference on Conceptual Modeling (ER 2003) (Chicago, IL, USA, October 13–16, 2003), LNCS, 2813, Springer, Berlin, 2003, 232–245

[12] Rossi G., Pastor O., Schwabe D. et. al., Web Engineering: Modeling and Implementing Web Applications, Springer, Berlin, 2007, 464 pp.

[13] WebRation toolkit URL: http://www.webratio.com

[14] Romanovskii K. Yu., Koznov D. V., “Yazyk DRL dlya proektirovaniya i razrabotki dokumentatsii semeistv programmnykh produktov”, Vestn. S.-Peterb. un-ta. Ser. 10: Prikladnaya matematika, informatika, protsessy upravleniya, 2007, no. 4, 1–16

[15] Koznov D. V., Romanovskii K. Yu., “DocLine: metod razrabotki dokumentatsii semeistv programmnykh produktov”, Programmirovanie, 2008, no. 4, 1–13

[16] GS1 Standards Document, GS1 Global Traceability Standard, 2009

[17] Do Organisations Need Traceability?, Executive Summary. Theta Technologies Affiliated Resellers URL: www.informationleader.com/Web/

[18] Abadi A., Nisenson M., Simionovici Y., “A Traceability Technique for Specifications”, Proc. of the 16th IEEE Intern. Conf. on Program Comprehension, 2008, 103–112 | DOI

[19] Sousa K., Mendona H., Vanderdonckt J., Pimenta M. S., “Supporting Requirements in a Traceability Approach between Business Process and User Interfaces”, Proc. IHC '08 of the VIII Brazilian Symposium on Human Factors in Computing Systems, 2008, 272–275

[20] Briand L. C., Labiche Y., Yue T., “Automated Traceability Analysis for UML Model Refinements”, Information and Software Technology J., 51:2, February (2009), 512–527 | DOI

[21] IEEE Std 1063-2001, IEEE Standard for Software User Documentation

[22] Edinaya sistema programmnoi dokumentatsii (ESPD), GOSTy serii 19 URL: http://standards. narod.ru/gosts/gost19/gost19.htm

[23] TheBat Documentation URL: http://allbat.info/

[24] ESET MOD32 Documentation URL: http://www.esetnod32.ru/

[25] Fauler M., UML. Osnovy, 3, Simvol-Plyus, SPb., 2006, 192 pp.

[26] Da Silva P. P., “User Interface Declarative Models and Development Environments”, A Survey, LNCS, 1946, 2000, 207–226

[27] Ivanov A., Koznov D., “REAL-IT: Model-Based User Interface Development Environment”, Proc. of IEEE/NASA ISoLA 2005. Workshop on Leveraging Applications of Formal Methods, Verification, and Validation (Loyola College Graduate Center Columbia, Maryland, USA, 23–24 September 2005), 31–41 | Zbl

[28] Eclipse Graphical Modeling Framework URL: http://www.eclipse.org/modeling/gmf/

[29] Saxon 9 Java API URL: http://www.saxonica.com/documentation/javadoc/index.html

[30] JExamXML Java API URL: http://www.a7soft.com/jexamxml/index.html

[31] A Framework for Software Product Line Practice. Version 5.0 URL: http://www.sei.cmu.edu/ productlines/