Design > Architecture > Components

Release Information

Project: PROJECT-NAME
Internal Release Number: X.Y.Z
Related Documents:
LINKS-TO-RELEVANT-STANDARDS
LINKS-TO-OTHER-DOCUMENTS
TODO: Briefly describe each component of 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.
TIP: Each interface can be an API (application program interface), standard protocol (e.g., HTTP), configuration 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.

C-00: COMPONENT-NAME

Description: DESCRIPTION
Environmental Constraints: REQUIRED HARDWARE, RAM, OPERATING SYSTEM, LIBRARIES, LICENSE KEY FILES, ETC.
Available Interfaces:
  • User interface
    • DETAILS
  • Application program interface
    • DETAILS
  • Configuration or administrative interface
    • DETAILS
  • INTERFACE-OR-PROTOCOL-NAME
    • DETAILS

C-01: COMPONENT-NAME

Description: DESCRIPTION
Environmental Constraints: REQUIRED HARDWARE, RAM, OPERATING SYSTEM, LIBRARIES, LICENSE KEY FILES, ETC.
Available Interfaces:
  • User interface
    • DETAILS
  • Application program interface
    • DETAILS
  • Configuration or administrative interface
    • DETAILS
  • INTERFACE-OR-PROTOCOL-NAME
    • DETAILS

C-10: COMPONENT-NAME

Description: DESCRIPTION
Environmental Constraints: REQUIRED HARDWARE, RAM, OPERATING SYSTEM, LIBRARIES, LICENSE KEY FILES, ETC.
Available Interfaces:
  • User interface
    • DETAILS
  • Application program interface
    • DETAILS
  • Configuration or administrative interface
    • DETAILS
  • INTERFACE-OR-PROTOCOL-NAME
    • DETAILS

C-11: COMPONENT-NAME

Description: DESCRIPTION
Environmental Constraints: REQUIRED HARDWARE, RAM, OPERATING SYSTEM, LIBRARIES, LICENSE KEY FILES, ETC.
Available Interfaces:
  • User interface
    • DETAILS
  • Application program interface
    • DETAILS
  • Configuration or administrative interface
    • DETAILS
  • INTERFACE-OR-PROTOCOL-NAME
    • DETAILS

C-12: COMPONENT-NAME

Description: DESCRIPTION
Environmental Constraints: REQUIRED HARDWARE, RAM, OPERATING SYSTEM, LIBRARIES, LICENSE KEY FILES, ETC.
Available Interfaces:
  • User interface
    • DETAILS
  • Application program interface
    • DETAILS
  • Configuration or administrative interface
    • DETAILS
  • INTERFACE-OR-PROTOCOL-NAME
    • DETAILS

C-20: COMPONENT-NAME

Description: DESCRIPTION
Environmental Constraints: REQUIRED HARDWARE, RAM, OPERATING SYSTEM, LIBRARIES, LICENSE KEY FILES, ETC.
Available Interfaces:
  • User interface
    • DETAILS
  • Application program interface
    • DETAILS
  • Configuration or administrative interface
    • DETAILS
  • INTERFACE-OR-PROTOCOL-NAME
    • DETAILS
TODO: Check for words of wisdom for additional advice on this template.
Company Proprietary
Copyright © 2003-2004 Method Labs. All rights reserved. License terms. Retain this copyright statement whenever this file is used as a template.