In this slide - I am trying to cover the best practices for different object naming conventions. Naming the object in such way to self describe its details and benefit for following standard naming convention. Benefit to Team and overall project schedule and maintenance.
3. INDEX
• Why is common development standard?
• Workspaces/Solution Standards
• Projects Standards
• Artifacts Standards
• Variables and Object Names standards
• Integration Team Roles
• Conclusion
4. COMMON DEVELOPMENT
STANDARDS
1. Terms
2. Concepts
3. Data formats
4. Document styles
5. Techniques
6. Development Patterns
Note: Complexity of a standard can vary
depending on what kind of problem.
5. BENEFITS
• Keep Development Schedule on Track
• Project Structure.
• Classes, constants, variables,
functions/methods, modules, packages and
files
• Guidelines and standards to follow
• Confidence to work as a Team
• Quality Assurance
• Deployment Ease
• Self-documenting through good naming
practices and known programming style
6. WORKSPACES/SOLUTION
STANDARDS
• Key pieces of information that you want to reflect in a Workspace
• For Example: Finance_Shared_Sharepoint_Prod_WestUs
Naming component Examples
Business unit Finance, Commercial, Sales, Operations
Subscription type Private, Shared
Application Sharepoint, CRM, Operation Software
Deployment environment Prod, Dev, Staging, Test
Cloud Provider Region westus, eastus2
7. PROJECT STANDARDS
• Key pieces of information that you want to reflect in a Workspace
• Example- WO12367_ERP_CRM_CustMstrSync
• Example of Sub Component: WO12367_ERP_CRM_CustMstrSync_GetCustInfo
• Add Complete Description, Meta Tags
Naming component Examples
Unique ID Work Order/JIRA ID
Source ERP
Target CRM
Purpose CustMstrSync
Sub Component GetCustInfo
8. ARTIFACTS STANDARDS
Key Artifacts
• Requirement Specification - BR_WO12367_ERP_CRM_CustMstrSync
• Technical Design Document – TD_WO12367_ERP_CRM_CustMstrSync
• Unit Test Case Document – UT_WO12367_ERP_CRM_CustMstrSync
• Functional Test/User Acceptance Testing – FUT_WO12367_ERP_CRM_CustMstrSync
• Technical Testing – TT_WO12367_ERP_CRM_CustMstrSync
• Deployment Document/Solution Run Book – RB_WO12367_ERP_CRM_CustMstrSync
• Knowledge Base – KB_WO12367_ERP_CRM_CustMstrSync
9. VARIABLES AND OBJECT NAME
STANDARDS
• Code should explain itself
• Four C: Communication, Code integration, Consistency and Clarity
• Different case: Camel, Pascal, Snake, Kebab, Screaming, Hungarian
Case Example
Camel userAccount
Pascal UserAccount
Snake User_Account
Kebab User-Account
Screaming USERACCOUNT
Hungarian strUserAccount
10. ROLES AND RESPONSIBILITY
• Request Sponsor
• Subject Matter Experts (SME) – Source and Target Systems
• Integration Owner – Business Side
• Project Manager (PM)
• Technical Leads
• Integration Developer
• Integration Testers
• Integration Support Team
11. TO SUM UP
• Please send all your questions to think.enterprisearchitecture@gmail.com
• Subscribe to my youtube channel for more videos on Enterprise Architecture
Planning: Think.EnterpriseArchitecture
https://www.youtube.com/channel/UCRRJZAqbNM0OONuC3GuzN6A