Skip to content

PROMPT_DESCRIBE_PACKAGE

Variables

Name Description Example
PACKAGE_NAME The name of the package to describe. Pardot
PACKAGE_XML The JsonL metadata for the package {"SubscriberPackageName":"Pardot","SubscriberPackageNamespace":"pi","SubscriberPackageVersionNumber":"1.0.0","SubscriberPackageVersionId":"04t1t0000000abcAAA","SubscriberPackageVersionName":"Pardot Version 1.0"}
PACKAGE_METADATAS A list of all metadata items (Apex classes, objects, flows, etc.) in the org that are provided by this package (namespaced). ApexClass: pi__MyClass, CustomObject: pi__MyObject, Flow: pi__MyFlow

Prompt

You are a skilled business analyst working on a Salesforce project. Your goal is to summarize the content and behavior of the Salesforce Installed package "{{PACKAGE_NAME}}" in plain English, providing a detailed explanation suitable for a business user. {{VARIABLE_OUTPUT_FORMAT_MARKDOWN_DOC}}

### Instructions:

1. **Contextual Overview**:
    - Browse the internet using Google to find the package's official documentation and provide an overview of its purpose and capabilities, with links to the documentation.
      - If you found the package's official documentation, summarize its key features and functionalities.
      - If you can not find the package's official documentation, provide a general overview based on the package attributes and its metadata components (but do not output the list of metadatas, it will be for paragraph 2).
    - Include any relevant information about the package's intended use cases or target audience.
    - If you can find other relevant information about the package, like articles or blog posts, in english or in the prompt reply language, provide them as a list of links
      - If you find the AppExchange page, include it in your response. Otherwise, don't mention it.
      - If you find the package's GitHub repository, include it in your response. Otherwise, don't mention it.
      - If you find the vendor information, include it in your response. Otherwise, don't mention it.
      - Make sure that hyperlinks are not dead links leading to 404 pages.

2. **Package Metadata**:
    - Review the list of metadata items (Apex classes, objects, flows, etc.) provided by this package, as listed in reference data.
    - Highlight the most important or business-relevant components.

3. {{VARIABLE_FORMATTING_REQUIREMENTS}}

### Reference Data:

- The attributes for Installed package "{{PACKAGE_NAME}}" are:
{{PACKAGE_XML}}

- The list of metadata items provided by this package is:
{{PACKAGE_METADATAS}}

- Many Salesforce managed packages are published by third-party vendors. You can find the package's vendor information in the Salesforce AppExchange (https://appexchange.salesforce.com/).

- There are also many open-source packages available on GitHub (github.com)

- Other relevant sources for articles or blog posts about the package may include the vendor's website, community forums, or Salesforce-related blogs, like Salesforce Ben or medium.com. Do not mention these source if you don't have a direct link to a page explicitly related to package "{{PACKAGE_NAME}}".

{{VARIABLE_ADDITIONAL_INSTRUCTIONS}}

How to override

To define your own prompt text, you can define a local file config/prompt-templates/PROMPT_DESCRIBE_PACKAGE.txt

You can also use the command sf hardis:doc:override-prompts to automatically create all override template files at once.

If you do so, please don't forget to use the replacement variables :)