One of the main issues that a company has to face is the generation and maintenance of product documentation. In particular, several software houses have to take into account the frequent need of rapidly updating software applications, and the corresponding technical documentation, as a consequence of changes in the administrative rules and laws. In order to support documentation generation and maintenance processes, we performed an ontological analysis of these processes in a large Italian software house that produces and sells enterprise applications for small-to-medium sized enterprises. The goal of such a domain analysis was to build a conceptual model enabling a formal characterization of the main elements involved in software documentation. Such a formalization represents the “competence” of a system supporting documentation processes, since it enables it to answer competency questions representing the information needs of the documentation writers (e.g., “In which technical sheets/application manuals/operating manuals is used a given concept?”; “Which technical sheets belonging to a given operating manual do mention a given functionality/screenful/form field?”; “Which are the functionalities/screenfuls/technical sheets potentially impacted by the change of a given software module/file?”).

Towards an Ontology-based Software Documentation Management - A Case Study

GOY, Annamaria;MAGRO, Diego
2012-01-01

Abstract

One of the main issues that a company has to face is the generation and maintenance of product documentation. In particular, several software houses have to take into account the frequent need of rapidly updating software applications, and the corresponding technical documentation, as a consequence of changes in the administrative rules and laws. In order to support documentation generation and maintenance processes, we performed an ontological analysis of these processes in a large Italian software house that produces and sells enterprise applications for small-to-medium sized enterprises. The goal of such a domain analysis was to build a conceptual model enabling a formal characterization of the main elements involved in software documentation. Such a formalization represents the “competence” of a system supporting documentation processes, since it enables it to answer competency questions representing the information needs of the documentation writers (e.g., “In which technical sheets/application manuals/operating manuals is used a given concept?”; “Which technical sheets belonging to a given operating manual do mention a given functionality/screenful/form field?”; “Which are the functionalities/screenfuls/technical sheets potentially impacted by the change of a given software module/file?”).
2012
International Conference on Knowledge Management and Information Sharing
Barcelona (Spain)
4-7 October, 2012
KMIS 2012 - Proceedings of the International Conference on Knowledge Management and Information Sharing
SciTePress – Science and Technology Publications
125
131
9789898565310
Software Documentation; Documentation Management; Ontology; Semantics
Anna Goy; Diego Magro
File in questo prodotto:
File Dimensione Formato  
pdf_editoriale_KMIS12.pdf

Accesso riservato

Descrizione: articolo
Tipo di file: PDF EDITORIALE
Dimensione 295.7 kB
Formato Adobe PDF
295.7 kB Adobe PDF   Visualizza/Apri   Richiedi una copia
KMIS2012_xIRIS_PostPrint.pdf

Accesso aperto

Descrizione: articolo
Tipo di file: POSTPRINT (VERSIONE FINALE DELL’AUTORE)
Dimensione 173.78 kB
Formato Adobe PDF
173.78 kB Adobe PDF Visualizza/Apri

I documenti in IRIS sono protetti da copyright e tutti i diritti sono riservati, salvo diversa indicazione.

Utilizza questo identificativo per citare o creare un link a questo documento: https://hdl.handle.net/2318/105961
Citazioni
  • ???jsp.display-item.citation.pmc??? ND
  • Scopus 5
  • ???jsp.display-item.citation.isi??? ND
social impact