Structure topics

Last Updated : Jul 04, 2017 |

Structure contains information describes the parts that make up a collection.

Definition

Structure information describes the constituent parts of a collection or assembly, such as

  • Part descriptions for any assembly

  • Field descriptions for a user interface screen

Note:

For field descriptions that are very complicated and require additional structure, such as tables within a field description, you can use a separate concept topic for each field and then aggregate the topics together in the map.

Purpose

Writers include structure information to quickly describe the function or purpose of each part in a collection.

Role in product content

Structure topics support tasks in information domains where tasks can be concretely described. Structure topics gain more importance in information domains that do not lend themselves to task-oriented content.

This information is also an Avaya specialization. Before deciding to do that, we tried to classify this sort of information as either concept or reference. We found that equally convincing arguments could be given for either choice. At that point, we decided that the information was really its own type, so we created a specialization for it.

Structure topic template

The following templates are available to create the Structure type topic:

Structure Use the Structure template for standard structure topics.

Graphical structure Use the Graphical Structure template for structure topics that describe the components in a container depicted graphically, such as the back view of a server. A callout table is included in the template.