Difference between revisions of "Architecture Conventions"
Jump to navigation
Jump to search
(Created page with "For conventions specific to specific artifacts & deliverables see the definitions of those items on their particular pages.") |
(Added a number of preliminary naming conventions.) |
||
| Line 1: | Line 1: | ||
| − | For conventions specific to specific artifacts & deliverables see the definitions of those items on their particular pages. | + | For conventions specific to specific [[SSC Artifacts and Diagrams|artifacts]] & [[SSC Architecture Deliverables and Reports|deliverables]] see the definitions of those items on their particular pages. |
| + | |||
| + | ==== Diagram Naming Conventions ==== | ||
| + | * Always use the full name of the item. An acronym, if applicable, may be placed in brackets. E.g.: System Monitoring Service (SMS) | ||
| + | * Never put service/function/process in the name of the element | ||
| + | * Prepend diagram names (WIP) to indicate diagrams that are "Works in Progress". E.g.: "(WIP)Business Intake Process". | ||
| + | * Prepend diagram names with a type/level if necessary. | ||
| + | ** For example, if one has a Business Process Cooperation Diagram for a Segment, do "Segment: Segment Name". E.g.: Segment: Connectivity | ||
| + | ** One might do several levels of diagram (conceptual, logical, physical). To indicate the level, one might append a "- conceptual" to a name. E.g.: Monitoring System - conceptual, or Monitoring System - logical. | ||
| + | * If a diagram is about a particular function/process/element in a larger scope, give the diagram the same name as the element. e.g.: A business process cooperation diagram describing the Data Center Facilities Management SSC service would be named: "Data Center Facilities Management". | ||
| + | * For SSC Service diagrams, one can prepend the title "Service:". e.g.: "Service: Data Center Facilities Management". | ||
Revision as of 13:25, 4 October 2019
For conventions specific to specific artifacts & deliverables see the definitions of those items on their particular pages.
Diagram Naming Conventions
- Always use the full name of the item. An acronym, if applicable, may be placed in brackets. E.g.: System Monitoring Service (SMS)
- Never put service/function/process in the name of the element
- Prepend diagram names (WIP) to indicate diagrams that are "Works in Progress". E.g.: "(WIP)Business Intake Process".
- Prepend diagram names with a type/level if necessary.
- For example, if one has a Business Process Cooperation Diagram for a Segment, do "Segment: Segment Name". E.g.: Segment: Connectivity
- One might do several levels of diagram (conceptual, logical, physical). To indicate the level, one might append a "- conceptual" to a name. E.g.: Monitoring System - conceptual, or Monitoring System - logical.
- If a diagram is about a particular function/process/element in a larger scope, give the diagram the same name as the element. e.g.: A business process cooperation diagram describing the Data Center Facilities Management SSC service would be named: "Data Center Facilities Management".
- For SSC Service diagrams, one can prepend the title "Service:". e.g.: "Service: Data Center Facilities Management".
