Architecture Description

Architecture description markdown templates.

Two different markdown templates are provided for describing architecture:

• Basic template: defines only the document's high-level structure, and does not give any specific direction for the contents
• Advanced template: uses the same structure as the simple one, but provides more sections for typical architectural contents

NOTE: the advanced template contains more sections than usually needed, have to be used only as suggestion for design documents, and many sections will need to be deleted when in use

Copy the contents to an empty markdown file and start editing. Remove the help text in block quotes and any unused sections.

Basic Markdown template

# Title / Feature

- Status: draft | pending | in-review | accepted

Abstract paragraph (optional)

[[_TOC_]]

## Requirements

- <Bullet list of relevant requirements> 

## Main heading

content

### Sub-heading

content (can refer to rationale)

## Document History

| date | author | comment |  status |
|:-----------:|:-----------:|:-----------:|:-----------:| 
| <date> | [Author](<email>)| Initial version|  draft |

## Rationale (optional)

Advanced Markdown template

# Title / Feature

- Status: draft | pending | in-review | accepted

Abstract paragraph (optional)

[[_TOC_]]

## Introduction

> This section gives the reader a brief introduction. This section is mandatory.

## Purpose of document

## Glossary

> This section explains the terms used in this architectural description. This section is mandatory.

| Definition | Description |
|------------|-------------|
|            |             |

## Current State

## Architecture solution

> This section describes the architecture solution in detail. This section is mandatory.

### Hardware

#### Interfaces

### Software

#### Interfaces

### Network

#### Interfaces

### Devices

### Development Environment

> This section explains the overall view of the development environment requirements. Since it can vary across subsystems, the focus is on the overall view. 

### System Goals and Objectives

#### Primary Goals

#### Performance Objectives

#### Reliability

#### Security

> This section explains any security considerations made in the architecture solution. Consider IEC 62443 (3-2, 3-3, 4-2).

#### Safety

#### Product Lifecycle and Extensibility

> This section explains the evolution goals and objectives, expecting a system lifetime of 10-15 years. The hardware and software selected should prove mature and have a roadmap or plan of evolutionary existence for this lifetime.

#### Localization / Internationalization

### Assumptions and Dependencies

### System Architecture and Views

#### Composition / Build Block View

> This section describes the decomposition of the system into subsystems and so forth with diagrams and descriptions.

#### Functions

> This section describes the functions view on how and where the functions are going to exist as a part of the system. This is explained with diagrams and descriptions.

#### Modes

> This section describes the different modes in which the system is expected to work, e.g., Test mode with diagrams and description.

#### Source of Components

> This section clarifies the source from where the components are obtained, including open-source, sourced from 3rd-party like Kontron, etc., with diagram and description.

#### Runtime View

#### Interface / Interaction view

> This section describes the interfaces, i.e., the internal ones within subsystem and external interfaces with diagrams and descriptions.

#### Deployment View

> This section describes the allocation or where each subsystem goes and sits as a part of the system with diagrams and descriptions.

### Architectural Guidelines

> Below are the guidelines to be followed in extending or developing the system. The same has to be followed across subsystems also.

#### Extending the System

> This section describes the possible ways by which the system can be extended, i.e., what other functions can now be foreseen as part of the system.

#### Emerging Trends

> This section describes the impact of emerging technologies and trends on architecture. The relevant emerging trends which could impact the architecture as foreseen are documented here.

### Constraints or Limitations

## Alternative Solutions

## References

## Document History

| date | author | comment | status |
|:----------:|:-------------------------:|:-----------------:|:-------:|
| <date>    | [Author](mailto:<email>)| Initial version | draft |

## Rationale (optional)

- list of changes or rationale behind changes organized by sub-sections