2.3 KiB
Project
::PROJECT-NAME
Internal Release Number
::X.Y.Z
Related Documents
- Design > Architecture > Design Components
- ::LINKS TO RELEVANT STANDARDS
- ::LINKS TO OTHER DOCUMENTS
TODO: Briefly describe each component in the system. Focus on 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 that are specified in the UML class diagrams or other documents.
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.
TIP: Use an HTML anchor for each component so that a direct link can be made from other documents, issues, and email messages.
C-00: COMPONENT NAME
Description:
::DESCRIPTION
Environmental Constraints:
::REQUIRED OPERATING SYSTEM, RAM, ETC.
Available Interfaces:
::BRIEFLY DESCRIBE INTERFACES
C-01: COMPONENT NAME
Description:
::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