Howto:Guideline for Documenting Partner Apps: Difference between revisions

From innovaphone wiki
Jump to navigation Jump to search
Line 60: Line 60:
  ==Description==
  ==Description==
  <!-- Mandatory topic. -->
  <!-- Mandatory topic. -->
  <!-- Give description about the product, benefits, other information to mention to understand main product purpose -->
  <!-- Give description about the application, benefits, other information to mention to understand main product purpose -->
  <!-- place optional product logo or functional overwiew. -->
  <!-- place optional product logo or functional overwiew. -->
   
   
Line 84: Line 84:
  ==Functions==
  ==Functions==
  <!-- Mandatory topic. -->  
  <!-- Mandatory topic. -->  
  <!-- Give functional description about the product. Use formattings if needed -->
  <!-- Give functional description about the application. Use formattings if needed -->
   
   
  ==Licensing==
  ==Licensing==
Line 95: Line 95:
  <!-- If not present or outdated innovaphone FW is used, no certificate will be given at all -->
  <!-- If not present or outdated innovaphone FW is used, no certificate will be given at all -->
   
   
  Product versions used for interop testing:
  Application versions used for interop testing:
  <!-- replace 3rd-Pty-Product by real name -->
  <!-- replace 3rd-Pty-Application by real name -->
  * 3rd-Pty-Product Version
  * 3rd-Pty-Application Version
  <!-- adjust used innovaphone FW, if applied add further applications (e.g. TAPI & Versions) -->
  <!-- adjust used innovaphone FW -->
  * innovaphone V13r2sr24
  * innovaphone V13r2sr24
   
   
  ==Configuration==
  ==Configuration==
  <!-- Mandatory topic. -->  
  <!-- Mandatory topic. -->  
  <!-- Describe configuration steps to be done for both innovaphone and 3rd-pty product -->
  <!-- Describe configuration steps to be done for both innovaphone and 3rd-pty application -->
  <!-- If not present, no certificate will be given at all -->
  <!-- If not present, no certificate will be given at all -->
  <!-- you may either list the config steps by adding text & pictures, or provide the URL to a PDF-formatted config document. Ideally the document is hosted by the 3rd-party-supplier itself -->
  <!-- you may either list the config steps by adding text & pictures, or provide the URL to a PDF-formatted config document. Ideally the document is hosted by the 3rd-party-supplier itself -->

Revision as of 09:34, 12 October 2021

Scope

innovaphone supports execution of 3rd party Applications at the innovaphone myApps-ApplicationPlatform.

Apps are developped using the innovaphone SDK and may be published via the innovaphone AppStore.

Publishing 3rd party applications in the innovaphone AppStore require documentation for which a respective wiki article has to be created.

Existence of such an article is also prerequisite for the listing as a technology partner on innovaphone website.

Following a guideline on how to create and format this kind of article:

Main rules

The 3rd-party-application-developper 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 3rd-pty-product have to be put into the innovaphone wiki according to following standardized format.

Creation of a 3rd-party-product article

  • Login to innovaphone wiki
  • Open this instruction in the first browser tab
  • Open the following URL in a second window
http://wiki.innovaphone.com/index.php?title=Howto:productname_-_companyname_-_3rd_Party_Product&action=edit
  • 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 box below and paste it completely into the empty wiki-page

<!-- 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 done by innovaphone upon document check -->
<!-- Documentation of this product has been finalized October 12th 2021. -->

==Category==
<!-- Do not change this section and do not remove comments. Will be done by innovaphone upon document check -->
<!-- Application-middlewares -->
<!-- -->
<!-- -->

==Vendor==
<!-- Mandatory topic. -->
<!-- Give some introducting words about the vendor itself -->
<!-- Place optional company logo. Don't change logo size. -->
File:CompanyLogo.png

==Description==
<!-- Mandatory topic. -->
<!-- Give description about the application, benefits, other information to mention to understand main product purpose -->
<!-- place optional product logo or functional overwiew. -->

<!-- Some formattings WikiMedia supports:
==Title2==
===Title3===
xxx fat text
* - list item
-->

<!-- File:ProductLogo.png -->

<!-- some text -->

<!--Benefits at a glance:-->

<!--
* Bullet-point
* Bullet-point
* Bullet-point
-->

==Functions==
<!-- Mandatory topic. --> 
<!-- Give functional description about the application. Use formattings if needed -->

==Licensing==
<!-- Mandatory topic. --> 
<!-- Give information about costs and licensing model. Use formattings if needed -->

==Version==
<!-- Mandatory topic. -->
<!-- Give used versions for testing of both innovaphone and 3rd-pty product -->
<!-- If not present or outdated innovaphone FW is used, no certificate will be given at all -->

Application versions used for interop testing:
<!-- replace 3rd-Pty-Application by real name -->
* 3rd-Pty-Application Version
<!-- adjust used innovaphone FW -->
* innovaphone V13r2sr24

==Configuration==
<!-- Mandatory topic. --> 
<!-- Describe configuration steps to be done for both innovaphone and 3rd-pty application -->
<!-- If not present, no certificate will be given at all -->
<!-- you may either list the config steps by adding text & pictures, or provide the URL to a PDF-formatted config document. Ideally the document is hosted by the 3rd-party-supplier itself -->
<!-- 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 -->

==Contact==
<!-- Mandatory topic. --> 
<!-- Give contact details for potential interests. You may give personal or general contact data. -->

CompanyName
ContactName
Street
ZIP City Country
Tel:
Fax:
Mail: contactname@companyname

  • Start editing according to the comments given
  • 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 referral status upon successful document check