[Fiware-wpa] IMPORTANT: Approach for Architecture Specification Deliverable

[Juanjo Hierro]

  Of course the deliverables will be developed on the Wiki !    I thought it was clear that we won't longer generate word documents for any of the Public Deliverables ...

  What I haven't made my mind yet is where on the Wiki we will place the contents ... this might be a topic we discuss in our joint WPLs/WPAs confcall next Monday.

  I agree that in those cases where the specifications of APIs and Interfaces we are implementing match specifications already published by some standardization body, the contents of the Wiki will probably be not much more than a commented reference ...    But note that typically there is a divergence between what is actually implemented in the product and the public standard specifications (mostly when we are talking about standard specifications that are "in progress" or yet preliminary).   In those cases, we need to comment on what are the differences.    May you elaborate on any particular case you have in mind ?  Then we may agree on how to handle it ...

  Best regards,

-- Juanjo

On 01/12/11 09:29, Leidig, Torsten wrote:
Dear Juanjo,

thanks for the information. However, I think it’s of only limited value. Please provide a concrete template for the specification documents!
How about using the Wiki for documentation again?

FI-Ware is not a standards organization. Please be aware that some of the specifications that where developed in conjunction with FI-Ware will probably be published in a standardization community using their formats. The FI-Ware spec will probably be not much more than a commented reference.

Best regards,
Torsten

Dr. Torsten Leidig
SAP Research Center CEC Karlsruhe
SAP AG
Vincenz-Prießnitz-Str. 1
76131 Karlsruhe
T +49 6227 7 52535
F +49 6227 78 29753
E torsten.leidig at sap.com<mailto:torsten.leidig at sap.com>
http://www.sap.com
Pflichtangaben/Mandatory Disclosure Statements: http://www.sap.com/company/legal/impressum.epx
Diese E-Mail kann Betriebs- oder Geschäftsgeheimnisse oder sonstige vertrauliche Informationen enthalten. Sollten Sie diese E-Mail irrtümlich erhalten haben, ist Ihnen eine Kenntnisnahme des Inhalts, eine Vervielfältigung oder Weitergabe der E-Mail ausdrücklich untersagt. Bitte benachrichtigen Sie uns und vernichten Sie die empfangene E-Mail. Vielen Dank.

This e-mail may contain trade secrets or privileged, undisclosed, or otherwise confidential information. If you have received this e-mail in error, you are hereby notified that any review, copying, or distribution of it is strictly prohibited. Please inform us immediately and destroy the original transmittal. Thank you for your cooperation.



From: fiware-wpa-bounces at lists.fi-ware.eu<mailto:fiware-wpa-bounces at lists.fi-ware.eu> [mailto:fiware-wpa-bounces at lists.fi-ware.eu] On Behalf Of Juanjo Hierro
Sent: Mittwoch, 30. November 2011 15:39
To: fiware-wpl at lists.fi-ware.eu<mailto:fiware-wpl at lists.fi-ware.eu>; fiware-wpa at lists.fi-ware.eu<mailto:fiware-wpa at lists.fi-ware.eu>
Subject: [Fiware-wpa] IMPORTANT: Approach for Architecture Specification Deliverable

Hi all,

  As you know, we have to start working on the Architecture Specifications, which is one of the deliverables that is due in month 9, that is, end of January.

  My intention is to adopt a pragmatic approach, trying to generate something that can be integrated as part of the GE Open Specifications that we have to produce by month 12.

  My vision is that all GE Open Specifications should start with a chapter where an overview of the envisioned Architecture for the GE is described.   While style would be narrative, the description should be enough concrete, i.e., formulated over actual data type, interface and operation names and elaborating on the base interaction scenarios involving the different entities exporting the defined interfaces.   Then, after that chapter, the detailed specification of all data types and interfaces with their operations, are provided (this including signature of operations and accurate description of expected behaviour linked to operations)

  Then, the Architecture Specification deliverable would be just the result of developing this overview chapter.

  But nothing better than an example, so let me use one taken from OMG's set of CORBA Services Specifications.  Along my many years involved in different standardization efforts, I have found that OMG CORBA Service specs are rather comprehensive and close to what programmers (our ultimate customers!) love to see.

  Please find enclosed the CORBA Event Service Specifications.   What I would then select as the Architecture description are the contents of the following sections:

 *   The whole chapter 1
 *   Section 2.2 and 2.4 (which some people may have argued should have been included in chapter 1 :-)
  Note that anyone who reads the mentioned sections would get a CLEAR picture of what is the Architecture of the service and what are going to be the entities and interfaces/operations that will be supported in a compliant implementation.   The conceptual and programming model would be also rather clear from a programmer's perspective.   Therefore, rather valuable information for an application developer perspective which is what really should matter to us.    A side benefit is that what will remain as pending regarding GE Open Specifications will be less, that is, the detailed specification of data types and interfaces/operations.

  One thing that we will have to define is the set of conventions that we should all follow whenever we need to draw any figure, like figures 1-x or 2-x.   For this, Thomas and me will come soon to you with a proposal in short time.

  Please take your time to analyze this carefully and formulate any question you may have.

  From now on, I assume that you will start planning activities in Sprint 2 and 3 dealing with development of these specifications within each of your chapters.   This may well take the form of Work Items in the tracker.

  Best regards,

-- Juanjo

________________________________
Este mensaje se dirige exclusivamente a su destinatario. Puede consultar nuestra política de envío y recepción de correo electrónico en el enlace situado más abajo.
This message is intended exclusively for its addressee. We only send and receive email on the basis of the terms set out at.
http://www.tid.es/ES/PAGINAS/disclaimer.aspx

________________________________
Este mensaje se dirige exclusivamente a su destinatario. Puede consultar nuestra política de envío y recepción de correo electrónico en el enlace situado más abajo.
This message is intended exclusively for its addressee. We only send and receive email on the basis of the terms set out at.
http://www.tid.es/ES/PAGINAS/disclaimer.aspx
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.fiware.org/private/fiware-wpa/attachments/20111201/31eab5f8/attachment.html>