Intelligent Product Manuals

Conclusions

The framework that is presented in this paper models the main features of an application for documentation systems. The main entities involved in the process are identified and abstracted in a software framework.

The system as it is shown in the case study is capable of generating a fully functional Virtual Document. It allows dynamic updating of the data and offers a rich set of utilities such as the dynamic linking, personalised output based on the XML data, dictionary support, etc. The application can be executed as it is or extended to provide solutions customised to more specific needs of documentation systems.


Case Study

In the left frame, the menu that was prepared by the components is presented. In the case that the links are followed a coded request towards the information components of the web application will be generated. In the middle frame the report developed by the currently addressed component is illustrated. The first part of the report is a dynamically generated natural language section describing the structural positioning of the component. The next part is a textual description of the entity represented by the component that has been preprocessed by the text processor and hyperlinks have been added. Next to the link there is the star (*) link that produces the results in the right frame. Then a graphic is presented and finally a selection from the contents of a XML file is included that is based on the processing of the corresponding “user model” and “set of rules” entities. In the right frame, lexically related items and links to dictionary definitions are created according to the text processor results.

In the next Screenshot the Entrance State of the web application is shown. The user model updating form and the login screen are included in the other windows. This application implements a documentation system with a structural menu based on the product structure, customised reports on all assemblies, subassemblies , parts, and equipped with navigational aids for the documentation user. 


System Architecture

The system architecture can be viewed as a combination of the five distinct subsystems identified earlier. The User Management contains the Login handler and the User Model components. The Login Handler identifies the user according to his username and password. Then the User Model object, according to the username, finds and retrieves the previously set values of the user model for the specific user. The Document Component integrates different behaviours according to a set of interfaces. The primary behavior is this of the component. The second main behaviour of the component is that of a placeholder for data. The Report Interface generates reports of the data contained by the component in the form of HTML Documents. The Rule Engine component is an abstraction that supports simple IF THEN rules and acts as a wrapper to a proper rule based engine if needed. The PDM Integration component, consists of three parts, the PDM Monitor which is the main controller class, the check for updates, which uses a timer and probes the files to check for updates, and the node objects that act as an intermediate placeholder for the data. The Text Processing subsystem includes the Text Processor and the Product Dictionary. The Product Dictionary keeps a record of all the component names instantiated. The Web Integration module comprises of a set of Servlets that feed the output of the components reporting interface to the web. The Servlets also handle the requests received by parsing the parameters and feeding them to the root component.


Enabling Technologies

There are various Object Oriented technologies that are useful when designing such an application. Some that are strongly advantageous for a documentation system application are Servlet technology, Java Database Connectivity, Java-based XML Parsers, and text pattern-matching tools such as regular expressions. Servlets are a new technology from Sun Microsystems. They aim to replace CGI technologies that have a number of shortcomings, including platform dependence and lack of scalability. Java Data Base Connectivity (JDBC) provides cross-DBMS (Database Management System) connectivity to a wide range of SQL (Standard Query Language) databases and access to other tabular data sources, such as spreadsheets or flat files. The eXtensible Mark-up Language (XML) is a text-based mark-up language that is becoming the standard for data interchange. It is used to identify data using tags. Text pattern matching can be very useful as a search tool for text documents. By identifying strings that represent meaningful identifiable terms in a domain, one can automatically discover relations and links between different sets of data.

Documentation Sub-systems

 The first question that has to be answered for the creation of such a framework is what needs to be abstracted? What is it that this framework has to model? Such a framework has to provide basic functions commonly met in documentation systems and allow the developers to extend these resources, customising them to meet the need of their current product documentation development needs. The main subsystems that can be identified in this problem domain are shown above.The User Management subsystem has to handle the users authentication and user model management issues. The Document Component should be able to handle and manage the product data, acting as a placeholder and as a manager, extracting, updating and forwarding the data towards the Web Interface. A Rule System is needed within the framework to utilise the user model and exert the adaptive strategy to the document components. The PDM integration module must ensure that the PDM is continuously monitored and that the data are extracted and updated at run-time. The Web Integration component provides the gateway to the web.The Text Processing component is concerned with the processing of the textual part of the data. This can assist in uncovering links, textual relations within the application and terms that can be related to external resources.

Software Frameworks

Software Frameworks aim to Model the Entities of a Specific Domain. This way the domain concepts are abstracted and a reusable set of classes is created. This increase productivity greately and creates a standardised conceptualisation of the specified domain. Through the code reuse the debuging and the quality of the code increases.

Product Documentation

Product documentation has moved from the traditional paper based form into electronic form. As a continuation of this evolution process and through the research conducted on Intelligent Product Manuals, interactive electronic technical manuals (IETMs), and electronic performance support systems (EPSSs), the product documentation becomes web-enabled, adaptive, with expert system support and thus transforms into a software system.

An Object-Oriented Framework for Intelligent Product Manuals

In this paper, an Object-Oriented Framework for the generation of electronic technical manuals is presented.  First the problem of documentation generation is discussed. The lack of infrastructure and its effect on the documentation development cycle is then analysed. The need for an Object-Oriented framework that will increase the productivity and will ensure a better information system quality is explained. Furthermore, the technologies enabling the development of systems for generating documentation are outlined, and the system architecture and a case study are described. Finally, the expected benefits of employing such systems are discussed.


Syndicate content

Who's online

There are currently 0 users and 129 guests online.
Validate XHTML, CSS or WCAG