Skip to main content

Product Capability Template

Product capability markdown template for ADO.

Markdown template

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

# \<Product name\> capabilities (E.g. NC800M capabilities)

---

# Table of contents

[1. Overview](#Overview)
[2. Capabilities](#Chapter-2.-Capabilities)
etc.

## Chapter 1. Overview

Describe an overview of the product.
It might be a good idea to prepare a block diagram in plantUML if it supports the reader's understanding.

## Chapter 2. Capabilities

Here details about the supported capabilities can be given.
Include plantUML sequence diagrams if they will help the reader's understanding.

### Chapter 2.1 Subchapter (E.g. Connectivity capabilities)

### Chapter 2.2 Subchapter (E.g. Redundancy capabilities)

### Chapter 2.3 Subchapter (E.g. OS Support capabilities)

## Chapter 3. Product tests

The described capabilities above have been verified using automated tests located in the same repository as this document and using manual tests described in the Test Suite(?) found here: [Link]()

## Chapter 4. Related documentation

For a detailed design and architecture description of NC800M, follow these links:

- [Architecture of NC800M](https://dev.azure.com/ABB-PA-CommonComponents/IA_Common/_wiki/wikis/System%20Architecture?pagePath=/System%20Parts/NC800M)
- Detail design: NC800M Platform: file://abb-is-000633.nmea.abb.com/Successful_Builds/CCCP/continuous_integration/Platform/int/SDKs/LatestDocumentation/html/index.html
- Detail design: NC800M Execution service: file://abb-is-000633.nmea.abb.com/Successful_Builds/CCCP/continuous_integration/AC800MExecService/LatestDocumentation/html/index.html
...

Related components and links to their component capabilities documents:

| Components |
| :----------: |
| [AC800M Execution Service](https://dev.azure.com/ABB-PA-CommonComponents/IA_Common/_git/Control_AC800MExecService?path=/AC800MExecService/Documentation/AC800M/Capabilities.md&_a=preview) |
| [Component X](https://google.com) |

## Chapter 5. Definitions/terminology

| Term | Definition |
| :-----: | :--------------------------------- |
| ARM | Advanced RISC Machine |

---

## Chapter 6. References

| Ref | Document Identity | Document Title |
| :----: | :----------------------------------------------------------------: | :------------------------------------------- |
| [ReX] | [Document ID](https://google.com) | Threat model for NC800M |
| [ReY] | [PlantUML Sequence Diagram](https://plantuml.com/sequence-diagram) | PlantUML Sequence Diagram |

Owner: Requirements Team