Howto:Guideline for Documenting Partner Apps

From innovaphone wiki
Jump to navigation Jump to search


innovaphone supports execution of Partner Applications at the innovaphone myApps Application Platform.

Apps are developed using the innovaphone SDK and may be published via the innovaphone App Store.

To achieve a higher level of awareness, App development Partners (App Partners) may be listed as technology partner on the innovaphone website and they can describe their App here in the innovaphone wiki in addition to the presentation in the innovaphone App Store.

This requires the documentation of the product by a respective wiki article.

In the following you can find a guideline on how to create this kind of article:

Main rules

The App development partner or any appropriate partner are exclusively responsible for

  • creation of this document
  • updating this document in case of any product changes
  • inital and regression testing of the product and updates in conjunction with current innvaphone firmware
  • support of the product

Test results and other informational data concerning the Partner App product have to be put into the innovaphone wiki according to following standardized format.

Creation of a Partner App article

  • Login to innovaphone wiki
  • Open this instruction in the first browser tab
  • Open the following URL in a second window
  • Replace the terms "productname" and "companyname" by your data
  • Confirm your input by pressing Enter
  • A new empty wiki page titled with the given URL is generated and opened in editor mode
  • Copy the text content from the content template below and paste it completely into the empty wiki-page
  • Start editing according to the comments given
  • we request to describe the product in English only. No language mix.
  • DON'T forget to SAVE!
  • Upload appropriate files/images indicated by a red link
  • Inform your innovaphone contact when finished
  • innovaphone will set the correct product category and grant status upon successful document check

Content template

 <!-- replace CompanyLogo by real logo-name. Do not change size & alignment. Upload image by pressing red link -->
 ==Product Name==
 <!-- Mandatory topic. -->
 <!-- replace CompanyName & ProductName by real names and add URL to productpage -->
 CompanyName [ ProductName]
 ==Certification Status==
 <!-- do not remove comment. Will be added by innovaphone upon document check, app availablity in innovaphone-appstore & operational check -->
 <!-- Do not change this section and do not remove comments. Will be set by innovaphone upon document check -->
 <!-- {{Category:Product categorie to be filled by innovaphone}} -->
 <!-- [[Category:Product categorie to be filled by innovaphone|{{PAGENAME}}]] -->
 <!-- Mandatory topic. -->
 <!-- Place optional company logo. Don't change logo size. -->
 <!-- Give some introducting words about the vendor itself. -->
 <!-- At max 3 sentences, no novels. -->
 BlaBlaBla (not: we are the best)
 <!-- For further information refer to vendor website via link -->
 [https://www.vendor.tld/ VendorName - About us]
 <!-- Mandatory topic. -->
 <!-- place optional product logo or functional overwiew. -->
 <!-- Give description about the main product purpose. -->
 <!-- At max 3 sentences, no novels. -->
 xyz application is used to manage call flows within innovaphone PBX (not: this application is the best)
 <!-- For further information refer to vendor product website via link -->
 [https://www.vendor.tld/productpage VendorName - About this application]
 <!-- Some formattings WikiMedia supports:
 '''xxx''' fat text
 * - list item
 <!-- [[Image:ProductLogo.png]] -->
 <!-- some text -->
 <!-- Mandatory topic. --> 
 <!-- Give functional description about the application. Use formattings if needed -->
 <!-- Preferred format is a short list of functions/buzz words offered by the product --> 
 * Feature1
 * Feature2
 * Feature3
 ===Multi-PBX ready===
 <!-- Mandatory topic. --> 
 <!-- Give statement about product usability in Multi-PBX-systems / Master-Slave -->
 <!-- If applicable, provide hints about required configuration steps below in the chapter Configuration --> 

 ===Cloud ready===
 <!-- Mandatory topic. --> 
 <!-- Give statement about product usability in Cloud-environments / Hosted PBXes -->
 <!-- If applicable, provide hints about required configuration steps below in the chapter Configuration --> 

 === Provided APIs ===
 <!-- Optional topic. --> 
 <!-- name APIs which product provides - if any --> 
 <!-- e.g. some of these --> 
 * API1
 * API2
 * API3
 <!-- Mandatory topic. --> 
 <!-- Give information about costs and licensing model. Use formattings if needed -->
 <!-- Optional topic. -->
 <!-- If applicable, name any system requirements / technical requirements. For example, if the function of the free app requires the use of software for which a fee is charged. -->
 <!-- Mandatory topic. -->
 <!-- If not present or outdated innovaphone FW is used, no certificate will be given at all -->
 ===Compatible innovaphone firmware versions===
 <!-- List compatible major innovaphone firmware versions. Several listings are valid -->
 * innovaphone V13r?
 ===Application versions used for interop testing===
 <!-- Give used versions for testing of both innovaphone and 3rd-pty product -->
 <!-- replace 3rd-Pty-Application by real name -->
 * vendorname productname versionno
 <!-- adjust tested innovaphone FW -->
 * innovaphone V13r?sr?
 <!-- Mandatory topic. --> 
 <!-- Describe configuration steps to be done for both innovaphone and 3rd-pty application -->
 <!-- We recommend to add a link to your website providing this information or alternatively provide a PDF-formatted config document. -->
 <!-- List the config steps by adding text & pictures -->
 <!-- Name used APIs to be activated in ap-objects -->
 <!-- Also list required configuration steps for Multi-PBX-systems and/or Cloud-environments if applicable when stated above -->

 <!-- If not present, no certificate will be given at all -->
 <!-- in any case you must be aware of the fact that any questions concerning configuration issues will be directly forwarded by innovaphone to you as manufacturer -->
 <!-- Mandatory topic. --> 
 <!-- Give contact details for potential interests and support. --> 
 <!-- You may give personal or general contact data or refer to external contact page -->
 | CompanyName
 | ContactName
 | Street
 | ZIP City Country
 | Tel: 
 | Fax:
 | Mail: [mailto:contactname@companyname contactname@companyname]

 For any questions please refer to [https://www.vendor.tld/contact our contact page].