« HELP CENTER

Component Documentation

We require two pieces of documentation in order to certify your component:

Detailed Documentation

This document is meant as a reference for the ad designer/developer using your component in their ad. It should make it clear what the component does and how the ad designer can use it, as well as answer any questions the person may have about component use. It should be thorough and complete, and include information about each of the following topics.

  • Component overview: What the component does and why advertisers would want to use it.
  • Component features, capabilities, and limitations: What the component can and cannot do.
  • Component structure and workflow: How your component is structured (for instance, it may have multiple views), and how a user might interact with the component.
  • Component-specific best practices: Any recommendations you have for how advertisers should or should not use your component.
  • Settings: A listing and explanation of each configuration setting in your component. This is important! If an advertiser does not understand what a particular setting does, they should be able to use this as a reference.
  • Metrics: A list of all events tracked by this component.
  • Support information: What a customer should do if they have questions using the component. While Flite can field most questions regarding the component, there will be questions that require your expertise, and the customer needs a contact for such questions.

See here for an example of detailed documentation of the ePrize Flite Hub components, and check out documentation for Flite Hub built-in components in the Ad Studio online help.

Summary Sheet

This document is targeted at people who have not yet purchased this component, but may be interested in doing so. This sheet, along with the demo ad, is meant to help get Flite customers and prospects interested in your component. It should list the component’s main selling points and key features, and include some attractive screenshots of your component.

See here for an example of a summary sheet for our ePrize component. We ask you to provide the information below, and then work with you to create a summary sheet from that information.

  • Component name and maker.
  • Introductory paragraph summarizing what the component does, and what value it adds to an ad campaign.
  • A bulleted list highlighting the component’s key features.
  • One or more screenshots, showing what the component looks like.
  • Some indication of component workflow, or how the user might interact with the component.
  • Some basic event tracking information to show the metrics this component can collect.