¶ Where to Store and Find the Documentation:
- Word document
- Found in CVI - Connect → Files → Integration Documentation → Systems
- Nuclino
- Found in Clarity Products → Connector (Integration platform) → System Documentation
- Use the Connect document template:
Integration Documentation Template V1.docx
- Also found in CVI - Connect → Files → Integration Documentation → Templates
- General setup of the system connector
- App pools
- Permissions
- Web Services
- API
- How to interface with the system
- SOAP API
- REST API
- Business Object Interface
- Previous project connecters
- Pulling from previous project connectors
- App settings that are required
- Walking through a sample job(s)
- Process for Generating a new entity as well as the service layer methods for the new entity
- General best practices, workaround, or possible issues
- Scripts
- Error logging from the ERP
- Server agents
- System provided documentation
- Include any documentation that is provided from the ERP/CRM/EComm
- Formatting (10/10)
- Accessible within Nuclino
- Accessible within Azure Wiki
- Accessible within the latest version of the Connector
- Access Instructions (10/10)
- Steps for:
- Credentials
- General Access
- API Creation
- Preferences
- Images Provided (10/10)
- Screenshots of:
- UI
- Step-by-step process
- General Instructions
- Inside the Connector
- Code Snippet of individual job setup (10/10)
- Product
- Customers
- Sales Orders
- Invoices (optional)
- Payment Receivable (optional)
- Refunds/Returns (optional)
- Structure of Connector (10/10)
- Data Structure of the System (10/10)
- How is data accessible and viewable within the system
- Walking through the Job process (10/10)
- Screenshot of an example workflow formated in steps
- Error Handling (10/10)
- System error accessing process examples:
- Development Specific Issues (10/10)
- Listing out errors and issues that are common to the system
- For example, Sage 100 has issues with pulling in live Purchase Order data compared to pulling in Purchase Order Historical data
- Client Specific Notes (if applicable) (10/10)
- Examples of client-specific issues, notes, or request to format
- Sales Documentation (10/10)
- Total Score 100/100
- Each line item above adds to the total score of the Content
- The total score will then need to hit a specific threshold to be considered ready for general usage
- The total score under the threshold will need to be updated and re-reviewed by a senior developer
- Once a score is given, the score will need to be updated within the Connect Team Management Book for Documentation