Problem Analysis

Meta information:

Topic: Problem Analysis
Reader: all
Version: 0.2
State: work in progress

Problem Analysis

Premises

In this section we try to describe the manual from the two basic points of view: the user and the writer.

From the user point of view the manual is a monolithic structure with a promoted sequential access where the user is left to a completely free consultation. Actually, the information centre provides a manual usable by a tree bar navigation.

  • A unique manual is written for different type of users such as technical and manager
  • The manual has a flat structure where the information does not have a semantic notation
  • The information inside the manual is not connected, there are not explicit relations among contents

From the writer point of view the manual (actually information centre) is a sequence of DITA files that represent the "topics" of the manual.

  • The writer classifies the information in "topics" divided in "task", "concept" and "reference"
  • The writer studies the connection among the information to do the manual
  • The writer builds a manual considering the type of user and objectives of the manual composing different DITA files
  • The manual is a compiled version of a set of DITA files

Discussion

Starting from our premises and observing the information centre link we try to find out some problems.

The construction of a manual actually follows a DITA process. It is primarily oriented from a writer point of view in order to reuse topics and reduce development cycles. The manual is a linked collection of DITA files visualized in an information centre.

  • It does not consider the needs of the user for instance maximization of transfer knowledge in the minimum time
  • In the visual representation of the manual the relations are expressed inside the contents
  • The visual part flattens the semantic information associated in the contents
  • The navigation of the manual is not friendly for the user needs.

    The content map are cabled inside the manual pages make flat the model. The interaction with the user is limited by the compilation process. To introduce a much more user interaction is necessary to have:

  • The complete manual model to user side and
  • To pass from a totally compiled model to an interpreted/compiled model

    The advantages to have an interpreted approach with the complete model to client side are multiples:

  • Semantic research
  • Production of different view of user requests
  • Integration of personal user information
  • Dynamic creation of manual contents

Tools

\ \ \ \ \ \ \ \