Browse Prior Art Database

Method to regiment documentation systems on request based on desired content

IP.com Disclosure Number: IPCOM000236676D
Publication Date: 2014-May-08
Document File: 2 page(s) / 25K

Publishing Venue

The IP.com Prior Art Database

Abstract

The article describes the method to regiment documentation systems on request based on desired content. The method gives opportunity that user’s perception imposes structure of topics in documentation. The strength of our method lies in the fact that every topic that user is especially interested in, can became the main topic - the root one of the whole documentation. Thanks to that, one book/manual may have thousands of faces. The faces that user actually creates by reorganizing the content in such a way that interesting topics stick to one another. In other words user chooses one page of interest and reorganizes the whole book so it is no longer book about product; it becomes book about topic covered on the page.

This text was extracted from a PDF file.
This is the abbreviated version, containing approximately 51% of the total text.

Page 01 of 2

Method to regiment documentation systems on request based on desired content

Currently many products' documentation is vast. On the other hand, users usually try to look just for specific subject and do not want to study everything. Unfortunately the experience reveals that documentation is usually created in very rigid way. This means, users must follow predefined, very structured content e.g. using strict navigation tree. The possibilities to follow own path is not possible. Sometimes people may have an impression that documentation is actually not for them - they are for the documentation.

This problem can be solved to some extend, by providing different tutorials or using predefined goals in documentation. This definitely helps, however it never covers all the users' needs, especially because users' experience and expectations do not always match the vendors' ones. There is a lack of full flexibility in this subject.

Therefore it happens quite often that user finds two topic (documentation pages, items, chapters, etc.) related to each other according to own criteria but he/she still must travel through many navigation tree's elements (branches, leaves) to move from one topic to another, because the tree is created such a way.

Additionally it is very likely, that user miss some important portion of information traveling through the tree structure or any other auxiliary navigation system like links or references sections.

In other words, structure of topics in documentation imposes user's perception.

Known solutions:
- Already mentioned tutorials and predefined goals in documentation.

- Links embedded to body of documentation topics
- Reference sections
In general one may provide the link on particular topic to different topics that are related, so one will be moved there after one click without having to travel through all the tree elements.

Quite nice, however one cannot provide the links to everything based on e.g. all key words, as the number of links will exceed the content of particular topic. Additionally, just mentioned solutions are quite static and hard to maintain. Moreover one loses the big picture of the key word one are interested in, including what topics are nearby the topic one just wants to choose. The proposed method turns upside down known approaches. Having it applied, user's perception imposes structure of topics in documentation. The strength of our method lies in the fact that every topic that user is especially interested in, can became the main topic - the root one of the whole documentation. Thanks to that, one book/manual may have thousands of faces. The faces that user actually creates by reorganizing the c...