[Fiware-apps] Upcoming M24 SW / Unit Tests / Installation & Admin Guide / User & Programmers Guide Deliverables

Klein, Andreas andreas.klein at sap.com
Fri Mar 22 14:21:29 CET 2013


Dear WP3 Partners,

as you all should know our M24 deliverables are due to end of April. To achieve a high quality as well as to minimize the amount of last minutes changes we thought it might be a good idea to take action now and prepare our WP3 deliverables as good as we can with the information currently available(i.e. guidelines + feedback from the last review).

As a GE owner you may ask now "and what exactly do I have to deliver, what open issues are there and what do I have to fix?"
To answer these question we developed the following guidelines which should help you to improve your Generic enablers towards a successful M24 and the review.

Please also update the status of your contributions in the following Google spreadsheet (Status Tab):
https://docs.google.com/spreadsheet/ccc?key=0AqAv-3EPx91-dEdJbXJVRGFBR2ZHUDc3MGtSd1lNV1E#gid=0
you can also find the guidelines there in the "Guidelines" Tab.


D3.1.2 FI-WARE GE Open Specifications (PU)
All GEs:

-          check if you use somewhere the term preliminary, either in the page title or the GE description. If so, please remove the preliminary status

-          have a close look at the elements (i.e. Main Operations) your GE provides and clearly state if it's a mandatory or Optional Element. Example:

o   Main Operation A (mandatory)

§  The mandatory Operation A ...

o   Main Operation B (mandatory)

§  Operation B is mandatory for the XYZ GE and used to ....

o   Main Operation C (optional)

§  The optional Operation C...

-          New Features may lead to new Main Operations, maybe a new version of your GE Architecture diagram is necessary. Please update your Open Specification accordingly

-          also update the corresponding "Detailed Specifications" pages (i.e. remove the preliminary status, describe new operations)

New GEs:

-          Create the Open Specification page using this template: https://forge.fi-ware.eu/plugins/mediawiki/wiki/fi-ware-private/index.php/Open_specification_resubmission_template
according to the guidelines described here: https://forge.fi-ware.eu/plugins/mediawiki/wiki/fi-ware-private/index.php/Where_and_how_to_publish_Open_Specifications

-          Link your Open Specification Detail pages here https://forge.fi-ware.eu/plugins/mediawiki/wiki/fiware/index.php/Summary_of_FI-WARE_Open_Specifications#Applications.2FServices_Ecosystem_and_Delivery_Framework_Chapter

-          Do not forget the template for RESTful API specifications: https://forge.fi-ware.eu/plugins/mediawiki/wiki/fi-ware-private/index.php/RESTful_API_specification_template



D3.3.2 Installation and Administration  Guide (PU/ PP)
All GEs:

-          Try to provide links external sources if you are using OSS (e.g. documentation)

-          Is there a support forum/user group or other any other kind of support channel for you GE, or parts of your GE? Link it!

-          Check if your new Features require an update of your Inst&Admin Guides. If so, update it.


New GEs:

-          Create the Installation and Administration  Guide and link it in the "Product Guides" section of your GE on the Materializing page https://forge.fi-ware.eu/plugins/mediawiki/wiki/fiware/index.php/Materializing_Applications/Services_Ecosystem_and_Delivery_Framework_in_FI-WARE

D3.4.2 User and Programmers Guide (PU)
All GEs:

-          Read your Guides again and try to update it with focus on the end user perspective if applicable. Try to make your user Guide look more appealing by e.g. adding a couple of screenshots

-          Describe new functionality which derives from the new features you developed.

New GEs:

-          Create the User and Programmers  Guide and link it in the "Product Guides" section of your GE on the Materializing page https://forge.fi-ware.eu/plugins/mediawiki/wiki/fiware/index.php/Materializing_Applications/Services_Ecosystem_and_Delivery_Framework_in_FI-WARE


D3.5.2 Unit Testing Plan and Report (PP)
All GEs:

-          Try to enhance already defined Unit Tests. Is there really a specific Unit Test for each existing feature? If not, add at least one test for each features.

-          Add unit tests for your new Features
New GEs:

-          Create the Unit Testing Plan and Report and link it in the "Unit Testing Plan" section of your GE on the Materializing page https://forge.fi-ware.eu/plugins/mediawiki/wiki/fiware/index.php/Materializing_Applications/Services_Ecosystem_and_Delivery_Framework_in_FI-WARE


D3.2.2 SW Release (PU/ PP)
All GEs:

-          Upload the second Version of you SW Release either

here:                    https://forge.fi-ware.eu/scmrepos/svn/fi-ware-review/trunk/FI-WARE/Apps/             (PP)

or here:               https://forge.fi-ware.eu/scmrepos/svn/fiware/trunk/FI-WARE/Apps/                           (PU)

-          stick to the naming conventions


If you have any questions, feel free to contact me.

Best regards

Andreas

Andreas Klein
SAP AG
SAP Research Center Karlsruhe
Vincenz-Priessnitz-Strasse 1
D - 76131 Karlsruhe

T +49-6227-7-52554



Andreas Klein
SAP AG
SAP Research Center Karlsruhe
Vincenz-Priessnitz-Strasse 1
D - 76131 Karlsruhe

T +49-6227-7-52554

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.fiware.org/private/old-fiware-apps/attachments/20130322/86abedee/attachment.html>


More information about the Old-Fiware-apps mailing list

You can get more information about our cookies and privacy policies clicking on the following links: Privacy policy   Cookies policy