This guide outlines best practices for documenting Norce Commerce solutions shared between Norce, customers, and solution partners.
- System architecture map
- Overview of the integration processes
- Functionality overview
- Special requirements or restrictions
- Contact information
This could be a system figure with additional comments and notes, that clearly states:
- System names as used in daily operations
- Role and responsibility of each system
- Connections with Norce Commerce (arrows with notes)
- Underlying platform information (e.g., "Fido" = Business Central)
Some more detail about the different integrations and how data flows between systems, like products, prices, stock, orders and other transactions.
Detail the following aspects:
- Data flow directions (in/out of Norce)
- Integration frequencies
- Data volumes
- Critical timing requirements (if exists)
A short description on what the customer has implemented. No details needed here unless there is something special about some function.
- List of active Norce modules
- Customization details
- Disabled modules
- Read-only functionalities
List functionality if there is something unique or uncommon about how the solution works.
- Custom-built functionalities
- Special implementations, like third party integrations
- How Norce helps with the functionality
Only list special requirements, like:
- Critical processes
- Timing dependencies
- Operating hours requirements
- Integration windows
Maintain updated contact details for:
- Solution partner representatives
- Customer key personnel
- Documentation owner
- Optionally support escalation paths
Some good tips and tricks are:
- Use commonly understood system names
- Keep documentation current (make sure it is updated yearly, quarterly or so)
- Maintain clear ownership of documentation
- Establish maintenance procedures and support processes with Norce, customer and partner