Formal Documentation - Draft for Review

Hello All,

Just a reminder that the formal FRED
documentation for 1.0 is available for review. The purpose of this document is
to formalize the working copy (available via http://facility-registry-api.readthedocs.org/en/latest/index.html#).
The target audience of the formal document is primarily architects and analysts.
The document focuses on syntax with some verbiage related to behaviors (if the
behaviors affect the exchange of data). The current draft covers the 1.0
release as of Jan 2013 (any changes to 1.0 made since that time have not been
reflected in this document). Please feel free to leave comments.

Thanks

-Justin

Apologies, the document is available here:

https://github.com/facilityregistry/docs/blob/master/FRED%20API%20Draft.docx

···

On Monday, February 11, 2013 12:03:34 PM UTC-5, Justin (Mohawk College) wrote:

Hello All,

Just a reminder that the formal FRED
documentation for 1.0 is available for review. The purpose of this document is
to formalize the working copy (available via http://facility-registry-api.readthedocs.org/en/latest/index.html#).
The target audience of the formal document is primarily architects and analysts.
The document focuses on syntax with some verbiage related to behaviors (if the
behaviors affect the exchange of data). The current draft covers the 1.0
release as of Jan 2013 (any changes to 1.0 made since that time have not been
reflected in this document). Please feel free to leave comments.

Thanks

-Justin

Hi Justin

I've got quite a lot of comments - though not sure I have time to make
them :-). What is the preferred mechanism for commenting? (Having
this word document still feels like something of a step backwards.)

As a general comment, which I have raised before but now feel it more
than ever, I am not sure this two-document process is actually the
most productive. With the document being maintained by Matt we have
quite considerable (admittedly sometimes painful) discussion and have
established I think a half decent workflow of capturing inputs and
resolutions.

Am I alone in thinking that it might actually be much more productive
if you focused on assisting with formalising Matt's text? Inserting
the diagrams, assisting with language etc. I think you've added some
good stuff here, but for us all to go through the process of reviewing
yet another document to make sure that you haven't too much liberty
with your own interpretation, strikes me as a doubling of effort.

Regards
Bob

···

On 11 February 2013 17:03, Justin (Mohawk College) <justin.fyfe1@mohawkcollege.ca> wrote:

Hello All,

Just a reminder that the formal FRED documentation for 1.0 is available for
review. The purpose of this document is to formalize the working copy
(available via
http://facility-registry-api.readthedocs.org/en/latest/index.html#). The
target audience of the formal document is primarily architects and analysts.
The document focuses on syntax with some verbiage related to behaviors (if
the behaviors affect the exchange of data). The current draft covers the 1.0
release as of Jan 2013 (any changes to 1.0 made since that time have not
been reflected in this document). Please feel free to leave comments.

Thanks

-Justin

--
You received this message because you are subscribed to the Google Groups
"Facility Registry" group.
To unsubscribe from this group and stop receiving emails from it, send an
email to facility-registry+unsubscribe@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.