Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. A description of the integration along with at least one high-level use case.

  2. A change log for future updates based on the version of the integration being released.

  3. A list of requirements in order to use the integration. This should specifically include:

    1. Any requirements for subscription/service-level within the third-party platform.

    2. Any requirements within the ThreatConnect Platform (dedicated/on-prem instance, etc).

  4. A set of instructions on how to install and/or implement the integration.

  5. A set of instructions on how to configure the integration including instructions for the ThreatConnect Platform if required for particular setups (custom attributes or indicator types).

  6. A set of instructions on how to use the integration including screenshots and at least one practical example.

  7. Instructions on how to contact you for support/assistance with the integration.

    1. This may be used by customers or by ThreatConnect resources to report any issues.

    2. You can refer to a portal or other site that provides information on this.

For Playbook Apps, the built-in Help Note and App Note (in the project Metadata) should be used to provide context to your integration and each parameter. These details can be summarized in your User Documentation along with a reference to these other fields.

...