Module discoverability

Ensuring module discoverability

To ensure that PRD-AI can reliably pull in modules from your Private catalog, your modules must have robust metadata. The metadata consists of two parts:  Module Details and Module Matching.

Module Details

The Module Details include the Title and Description. This data is specified in the meta.json file of the module. To make any changes to this data, you must edit the meta.json file in Git.

• Title — This information is presented anywhere this module is specified, such as the catalog page.

• Description — This information is presented shown in the catalog so users can determine the purpose of the module.

Module Matching

The Module Matching data includes details (Details and Acceptance Criteria) that are used to determine if the module matches a feature in a PRD. You add or change this data within your Private catalog.

• Details — This is one of the fields PRD-AI use to determine if the module matches a feature in a PRD. (The other field is Acceptance Criteria below.) The more detailed you make the Details, the more likely that the PRD-AI semantic matching will identify the module as a match to a requirement. This means that you want this to be descriptive enough that the AI can infer the meaning and match to it. The more detailed the better!

  • Example
    The following is the Details information for one of our Stripe Payments modules:

    The Stripe Payment Integration is a service that allows businesses to easily incorporate secure and reliable payment processing into their applications or websites. With Stripe, businesses can accept various payment methods, including credit cards, debit cards, and digital wallets.

    Some of the main features of the Stripe Payment Integration service include:

    1. Easy Integration: Stripe provides a simple and well-documented API that developers can use to integrate payment processing functionality into their applications or websites.

    2. Secure Transactions: Stripe ensures the security of customer transactions by using advanced encryption and fraud detection systems.

    3. Flexible Payment Options: Customers can make payments using various methods, such as credit cards, debit cards, and popular digital wallets like Apple Pay and Google Pay.

    4. Subscription Management: Stripe offers tools for managing recurring payments and subscription plans, making it suitable f or businesses with subscription-based models.

    5. International Support: With Stripe, businesses can accept payments from customers around the world, as it supports multiple currencies and handles international transactions seamlessly.

    Stripe Payments

    Stripe Payments focuses on processing online payments and managing transactions. Its use cases include:

    1. Processing Payments: Handling online transactions, accepting various payment methods like credit cards, debit cards, bank transfers, and digital wallets.

    2. Recurring Billing and Subscriptions: Managing subscription-based models, including automatic billing, subscription cycles, and prorating.

    3. Custom Checkout Experiences: Creating tailored checkout flows that match your brand and website design.

    4. Handling Refunds and Disputes: Automating refund processes and managing chargeback disputes.

    5. Fraud Detection an d Prevention: Using advanced tools to detect and prevent fraudulent transactions.

    6. Global Payments: Accepting payments in multiple currencies for international business operations.

    7. Invoicing and Billing: Generating invoices and handling both one-time and recurring billing.

    8. Financial Reporting and Reconciliation: Providing reporting tools for tracking payments, refunds, and related transactions.

    9. Mobile Payments Integration: Seamlessly integrating payment functions into mobile applications.

    10. Payment Method Management: Allowing customers to save and manage their payment methods for future use.

    11. Dynamic Pricing and Discounts: Implementing variable pricing and discount strategies.

• Acceptance Criteria — This is one of the fields PRD-AI uses to determine if the module matches a feature in a PRD. (The other field is Details above.) The more detailed this information is, the more likely that the PRD-AI semantic matching will identify the module as a match to a requirement. This means that you want this to be descriptive enough that the AI can infer the meaning and match to it. Provide details on the various acceptance criteria that this module would match. The more detailed the better!

  • Example
    The following is the Acceptance Criteria for one of our Stripe Payments Module:

    Acceptance Criteria for the Stripe Payment Integration:

    • The app should securely integrate with the Stripe payment gateway.

    • Users should be able to make payments using various payment methods supported by Stripe.

    • The payment integration should handle errors gracefully and provide clear error messages to users.

    • The integration should be able to handle different currencies and convert them accurately.

    • The app should ensure the privacy and security of user payment information.

    • The payment process should be well-documented and user-friendly.

    • The integration should be thoroughly tested to ensure it is free of bugs and errors before being deployed.

Edit the module details

1. In the catalog, select and open the module, and click Edit Module Details.
   The Details page includes the Title and Description for your reference.

2. Edit the Module Matching information.