Each section is designed to support a specific stage in the customer journey with your ERP extension.

1. New and planned

Help your customers stay up-to-date with the roadmap and version information for your ISV application.

• Supported versions: provide details about the currently supported versions of your ISV application and compatibility information.
• Planned updates: share information about upcoming features, including their expected release dates.
• Backlog: offer visibility into features in your development pipeline, even if specific release dates are not yet available.
• Changelogs: offer detailed documentation of changes organized by release version.
• Feature status: clarify which capabilities are in preview and which are generally available.

This section helps customers understand the development direction of your ISV application and provides visibility into upcoming capabilities and long-term plans.

2. Get started

Everything your customers need to begin their journey with your ERP extension.

• Business functionality overview: provide a high-level introduction to the features and capabilities your ISV application offers.
• Learning resources:
  • Training materials and courses.
  • Tutorial videos.
  • Step-by-step walkthroughs.
  • Demo data for practice.
• Trial information:
  • How to sign up for a free trial.
  • Options to extend the trial period.
• Purchase guidance:
  • Subscription information.
  • Pricing details.
  • Reseller and partner network.
• Reference materials:
  • Glossary.
  • Comparison with standard ERP functionality.
• Support information:
  • Frequently Asked Questions (FAQ).
  • How to get help and support.
  • Knowledge base resources.

This section helps end users quickly familiarize themselves with the ERP extension and begin using its core features.

3. Business functionality

Detailed information about core features and business processes.

• ISV application overview: present a summary of main features and capabilities.
• Walkthroughs: offer guided examples of common business scenarios.
• Setup and configuration:
  • Initial setup procedures.
  • Configuration options and best practices.
• Process documentation:
  • Detailed workflows.
  • Business process guides.
  • Step-by-step procedures.
• Design details and technical concepts.
• Operation guides: provide comprehensive instructions for daily operations.
• Industry-specific guidance: deliver specialized information for various sectors and use cases.

This section serves as the primary reference for understanding and effectively using the features of the ISV application.

4. Security, privacy, and compliance

Essential information about keeping data secure and meeting regulatory requirements.

• Security overview: share general security information and best practices.
• Privacy information: explain data handling protocols and privacy policies.
• Compliance certifications: provide details about regulatory compliance and standards.
• Protection mechanisms: describe features related to data security and protection.
• Service standards: outline information about your service commitments and guarantees.

This section helps ensure customer implementations meet security requirements and regulatory standards.

5. Development and administration

Technical resources for IT professionals, administrators, and developers.

• Environment information:
  • Online deployment guidance.
  • On-premises installation details.
• Installation and upgrade:
  • Installation procedures.
  • Upgrade paths and migration guidance.
• System requirements: list minimum hardware and software specifications.
• Customization:
  • Development guidelines.
  • Customization options and best practices.
• Integration: provide information about connecting with other systems.
• Technical details:
  • API documentation.
  • Event publishers.
  • Permission sets and security roles.
• Licensing: explain licensing models and requirements.
• Troubleshooting: address common issues and their resolutions.

This section provides the technical foundation for implementing, maintaining, and extending your ERP extension.

The documentation structure follows best practices established by ERP vendors, ensuring familiar navigation patterns for customers already working with the ERP system. You need a step-by-step approach to apply this structure to your documentation.