Changes between Initial Version and Version 1 of MarketRequirements

Timestamp:

Jun 27, 2011, 4:21:17 AM (13 years ago)

Author:

Andrew Boon

Comment:

--

MarketRequirements

@@ +1 @@
+= Boonex Market Product Requirements =
+
+== Common Requirements: ==
+
+'''Code convention'''[[BR]]
+All files should be written according to the [http://www.boonex.com/trac/dolphin/wiki/DolphinCodeConvention Code Convention].
+
+'''Demo'''[[BR]]
+Each product should be represented by screenshots, or a demo site, or any other way you can (screenshots, slideshow, portfolio, demo site).
+
+'''Read Me File'''[[BR]]
+Complete and structural [wiki:DolphinExtensionReq#ReadmeFiles Read Me file] (file name, build, version compatibility, installation etc.).
+
+'''Build-in modules installer wizard'''[[BR]]
+Installation should be presented as build-in module installer. Dolphin build-in installer process the SQL queries, language files and other tasks automatically.
+
+'''File naming'''[[BR]]
+The software should contain the product name and version in its name(the build number, if necessary).
+
+'''Version compatibility'''[[BR]]
+A product marked as compatible with Dolphin 7.0, for example, should be fully compatible with the mentioned Dolphin version without any additional necessary software or procedures.
+
+'''More than 1 file'''[[BR]]
+Each product should have more than one file, and the package itself should be packaged properly according to Dolphin 7.0 modules structure.
+
+'''Legal distribution'''[[BR]]
+To be able to offer products (integration modules, Copy and Paste Scripts, etc. ) which have proprietary or other private licenses, you should have the right to distribute it. You will have to grant your resellers rights.
+
+== Extensions: ==
+
+'''Dolphin module'''[[BR]]
+Each dolphin modification need to be presented as Dolphin module, with all required module structure. Event if it is small modification - it is required to present it as Dolphin 7 module.
+
+'''Admin panel'''[[BR]]
+Each product offered here should have admin panel which is accessible via Dolphin 7 admin menu.
+
+'''Additional functionality'''[[BR]]
+Any product offered here should provide additional functionality, Not bug fixes.
+
+'''Do not over-write Dolphin files'''[[BR]]
+You shouldn't over-write Dolphin files and then compose your installation manuals with something like: "take this file from my package and upload it to the Dolphin directory..." etc. Your over-written files could destroy another part of the Dolphin code.
+
+'''Less Modifications'''[[BR]]
+Try to implement your mod my making less modifications in Dolphin code, new Dolphin 7 structure allows you to responce to Dolphin alerts and make code injections without modifications at all - try to use these features as much as possible.
+
+== Language files:==
+
+'''100% translated original file'''[[BR]]
+The offered language file should be completely translated, manually is preferred.
+
+'''UTF formatted'''[[BR]]
+Dolphin is set up to work with UTF-8 encoding, and to avoid errors which may appear as different symbols the language file should be written in UTF-8 encoding.
+
+'''International standard'''[[BR]]
+The language should be marked with international standards marks. Language files should be named the following way: lang-country. Country and dash isn't mandatory. The language name must follow [http://en.wikipedia.org/wiki/ISO_639-1 ISO 639-1] (2002) standards and country name must follow [http://en.wikipedia.org/wiki/ISO_3166 ISO 3166] standards.
+
+'''Packaging'''[[BR]]
+Translation must be packaged according to [wiki:DolLang this manual].
+
+
+== Templates: ==
+
+'''Changed Uni template'''[[BR]]
+The offered template should be your own work with the structural code. The changed colors and pics of the Uni template (Dolphin default template) cannot be uploaded as a product.
+
+'''Copyrighted pictures'''[[BR]]
+The pictures used for the template design shouldn't be copyrighted. Be careful when choosing pictures for your products.
+
+'''Dolphin original footers'''[[BR]]
+!BoonEx footers should be intact in your template.
+
+'''File changes only'''[[BR]]
+The template package should be contained completely in the tmpl_templatename folder and consist of this folder only. It shouldn't change or be part of any other files.
+
+'''Structure'''[[BR]]
+Your template must not contain any copy paste code from base template, declare only pages, css styles and images which are different from base template.
+
+== Tutorials: ==
+
+'''Accessible file format'''[[BR]]
+The offered file should be presented in a format that makes it possible to read it easily without the installation of any additional applications.
+
+'''Completeness'''[[BR]]
+The product must contain full information and should describe all the nuances of the process described. (should cover the entire installation process).
+
+'''Detailed description'''[[BR]]
+The tutorial description should contain complete information about its content, which product and product version this file is for, and which program can be used to view it.
+
+'''No hack instructions'''[[BR]]
+The offered products should provide no information on how to hack !BoonEx software: licenses, links, etc.
+
+== Readme File(s) ==
+
+'''Product owner info:'''[[BR]]
+- Provider username (company name)
+- Provider contact data (username, full name, email address, address)
+
+'''Product info:'''[[BR]]
+- Product version
+- Product compatibility with Dolphin versions
+- License type
+- Upgrade possibilities (provide information on how your customers can get an updated versions if/when they are released)
+
+'''Installation manual:'''[[BR]]
+Complete set of instructions on how to install/integrate the product.
+
+'''User manual:'''[[BR]]
+Description of how the product works and how to manage it.