This guide provides best practices for creating and maintaining solution documentation for Norce Commerce implementations. Well-structured documentation ensures effective collaboration between Norce, customers, and solution partners. Each section below is self-contained and provides clear instructions for documenting different aspects of a Norce Commerce solution.
Before documenting a solution, ensure you have access to:
- System architecture diagrams or documentation
- Integration specifications and process flows
- Lists of active and inactive features
- Details of any custom or special requirements
- Up-to-date contact information for all stakeholders
Gather the following information before starting documentation:
- System names and roles as used in daily operations
- Integration points and data flow details
- List of all Norce modules in use, including customizations
- Any unique or non-standard requirements
- Contact details for all relevant parties
Follow these steps to create comprehensive solution documentation:
Provide a clear diagram or description of the system architecture. Include:
- System names (as used by users and in documentation)
- The role and responsibility of each system
- Connections to Norce Commerce (with annotated arrows)
- Underlying platform information (e.g., "Fido" = Business Central)
Describe how data flows between systems. For each integration, specify:
- Data flow direction (inbound/outbound relative to Norce)
- Integration frequency (e.g., real-time, hourly, daily)
- Typical data volumes
- Any critical timing or scheduling requirements
Summarize the main features and modules implemented for the customer. Include:
- List of active Norce modules and any customizations
- Disabled or limited modules and read-only functionalities
- Any special or unique functions
Document any unique or uncommon aspects of the solution, such as:
- Custom-built functionalities or third-party integrations
- Special business processes or workflows
- Non-functional requirements (e.g., critical processes, timing dependencies, operating hours, integration windows)
Maintain a current list of contacts, including:
- Solution partner representatives
- Customer key personnel
- Documentation owner
- Support escalation paths (optional)
- Use system names that are commonly understood by all stakeholders.
- Keep documentation up to date (review and update at least yearly or quarterly).
- Clearly assign and communicate documentation ownership.
- Establish documentation maintenance procedures and support processes with Norce, the customer, and the solution partner.