ReadySetGit/Design-Components.md

129 lines
2.3 KiB
Markdown
Raw Normal View History

2023-03-24 16:29:16 +00:00
<!-- markdownlint-disable-next-line first-line-h1 -->
2018-08-23 17:23:45 +00:00
##### Project
::PROJECT-NAME
##### Internal Release Number
2018-08-14 12:48:17 +00:00
::X.Y.Z
2018-08-23 17:23:45 +00:00
##### Related Documents
- [Design](Design) > [Architecture](Design-Architecture) > Design Components
2018-08-14 12:48:17 +00:00
- ::LINKS TO RELEVANT STANDARDS
- ::LINKS TO OTHER DOCUMENTS
---
2023-03-24 16:29:16 +00:00
_TODO: Briefly describe each component in the system. Focus on
2018-08-14 12:48:17 +00:00
architectural issues such as communication mechanisms, environmental
concerns that affect deployment options, and concurrency. Note key
aspects of each interface, but avoid duplicating details of interfaces
2023-03-24 16:29:16 +00:00
that are specified in the UML class diagrams or other documents._
2018-08-14 12:48:17 +00:00
Each interface can be an API (application program interface), standard
protocol (e.g., HTTP), config files, input data file format, or
interactive user interface (e.g., command-line or GUI). One component
may have multiple interfaces: e.g., a server may handle requests in a
standard protocol, but also have a config file, command-line options, an
administrative control panel GUI, and a performance monitoring API.
2023-03-24 16:29:16 +00:00
_TIP: Use an HTML anchor for each component so that a direct link can be
made from other documents, issues, and email messages._
2018-08-14 12:48:17 +00:00
---
### C-00: COMPONENT NAME
**Description:**
::DESCRIPTION
**Environmental Constraints:**
::REQUIRED OPERATING SYSTEM, RAM, ETC.
**Available Interfaces:**
::BRIEFLY DESCRIBE INTERFACES
---
### C-01: COMPONENT NAME
**Description:**
2021-08-01 11:41:38 +00:00
2018-08-14 12:48:17 +00:00
::DESCRIPTION
**Environmental Constraints:**
::REQUIRED OPERATING SYSTEM, RAM, ETC.
**Available Interfaces:**
::BRIEFLY DESCRIBE INTERFACES
---
### C-10: COMPONENT NAME
**Description:**
::DESCRIPTION
**Environmental Constraints:**
::REQUIRED OPERATING SYSTEM, RAM, ETC.
**Available Interfaces:**
::BRIEFLY DESCRIBE INTERFACES
---
### C-11: COMPONENT NAME
**Description:**
::DESCRIPTION
**Environmental Constraints:**
::REQUIRED OPERATING SYSTEM, RAM, ETC.
**Available Interfaces:**
::BRIEFLY DESCRIBE INTERFACES
---
### C-12: COMPONENT NAME
**Description:**
::DESCRIPTION
**Environmental Constraints:**
::REQUIRED OPERATING SYSTEM, RAM, ETC.
**Available Interfaces:**
::BRIEFLY DESCRIBE INTERFACES
---
### C-20: COMPONENT NAME
**Description:**
::DESCRIPTION
**Environmental Constraints:**
::REQUIRED OPERATING SYSTEM, RAM, ETC.
**Available Interfaces:**
::BRIEFLY DESCRIBE INTERFACES