If the interface requires communication connections between the client and service sides, use protocol "K" (Sockets) and provide a comment that describes the actual protocol to be used. Alternatively, you could extend the specification, adding a new standard protocol and update the standard stencil. Recommendation Details The first step is to determine whether the interface provider and consumer are to run in the same compute instance direct interaction or linked together into the same executable. If the interface between the components is a type of in-memory interface that requires no communication pathways between the two components, specify the "A" (Native) Protocol on the interface. When making this selection, it implies that these two modules are always deployed together on the same node in the Deployment Diagram. If the protocol runs over any kind of communications network, and cannot be represented by a protocol, select "K", for Socket (which implies at least a TCP/IP connection and potentially add a note to define the full protocol. What are some common errors to avoid in System Views? I am preparing set of UML component diagrams for my asset. Please describe some of the most errors in these diagrams so I can avoid them! Recommendation Common Diagramming mistakes: Using overly ambiguous or overly specific names. Inconsistent Interfaces across different system views. Specifying the interface type on connections between a given module and its internal components that handle those interfaces. Failing to specify the interface type for connections between components within the same outer module. Recommendation Details 1: Naming issues for components. One type of naming issue is simply choosing an inappropriate name for a module. For advice on this concern, please see The other major naming issue is inconsistent names across various diagrams for the same asset. In a architecture diagramming system, this is usually less of an issue because the repository retains and
If the interface requires communication connections between the client and service sides, use protocol "K" (Sockets) and provide a comment that describes the actual protocol to be used. Alternatively, you could extend the specification, adding a new standard protocol and update the standard stencil. Recommendation Details The first step is to determine whether the interface provider and consumer are to run in the same compute instance direct interaction or linked together into the same executable. If the interface between the components is a type of in-memory interface that requires no communication pathways between the two components, specify the "A" (Native) Protocol on the interface. When making this selection, it implies that these two modules are always deployed together on the same node in the Deployment Diagram. If the protocol runs over any kind of communications network, and cannot be represented by a protocol, select "K", for Socket (which implies at least a TCP/IP connection and potentially add a note to define the full protocol. What are some common errors to avoid in System Views? I am preparing set of UML component diagrams for my asset. Please describe some of the most errors in these diagrams so I can avoid them! Recommendation Common Diagramming mistakes: Using overly ambiguous or overly specific names. Inconsistent Interfaces across different system views. Specifying the interface type on connections between a given module and its internal components that handle those interfaces. Failing to specify the interface type for connections between components within the same outer module. Recommendation Details 1: Naming issues for components. One type of naming issue is simply choosing an inappropriate name for a module. For advice on this concern, please see The other major naming issue is inconsistent names across various diagrams for the same asset. In a architecture diagramming system, this is usually less of an issue because the repository retains and