Component

A component topic describes a component of a solution architecture.

When to Use Component Topic

Every solution architecture is comprised of a set of components. Use this topic type in case you want to describe one of these components, explain how it works and show how it interacts with other components in the architecture.

How to Use Component Topic

This topic structure consists of the following elements:

  1. Title — the name of an architecture component.

Use a title that consists of the name of the component.  

  1. Definition — a definition of the architecture component.

Describe what this component is about: for what purposes it is intended, what its functions are, and what it does.

  1. Rationale —  reasons for the component deployment.

Explain why users could need to deploy the component and what its benefits are (if any).

  1. Requirements — requirements for the component deployment.

List main hardware and software requirements that must be met to deploy the component:

  • Platform (physical or virtual) on which the component can be deployed.
  • Types of supported OSes.
  • Software that must be installed on the machine where the component will run.
  • Permissions that must be assigned to users and user groups who will have access to the component.
  • Other solution components and infrastructure objects to which the component must have connections.

Do not dive too deep into details. For example, do not list all supported platform versions or OSes — this is what the System Requirements section is for.

  1. [Optional] Architectureservices, modules and components installed along with the component.

If the component has a complex architectural structure, describe this structure (for example, the server part, UI part, embedded DB and so on).

  1. [Optional] Limitations limitations that exist for the component.
  2. [Optional] Diagram — an illustration of the component.

If you describe the component architecture, add a diagram that illustrates this architecture.

 

Component Topic

ComponentExample