Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This version:

https://aggateway.atlassian.net/wiki/x/AYB2Rg

Latest version:

https://aggateway.atlassian.net/wiki/x/AYB2Rg

Previous version:

https://aggateway.atlassian.net/wiki/x/PoDDJQ

Editor:

James A. Wilson, AgGateway, jim.wilson@aggateway.org

Please refer to the errata for this document, which may include some normative corrections.

Abstract

The AgGateway Digital Resources Development Process (DRDP) governs the process of producing and maintaining AgGateway’s Digital Resources.

Status of This Document

This is the version of the AgGateway Digital Resources Development Process.

This document has been approved by the AgGateway Board of Directors effective and has been endorsed by the AgGateway President as the AgGateway Digital Resource Development Process. It is a stable document and may be used as reference material or cited as a normative reference from another document. This policy was produced by the AgGateway staff.

Please report errors in this document to Member.Services@AgGateway.org. The list of known errors is public.

The English version of this policy is the only normative version.

Changes from Previous Version

Summary of Major Changes

  1. Added support for derived Digital Resource derivation and maintenance (section 5)

  2. Updated references to roles (e.g., Standards Director changed to COO or CTO).

  3. Updated reference to organizational unit (e.g., PMC and DRC).

Detailed Changes

Details

Table of Contents

Table of Contents
exclude\d\d\d\d-\d\d-\d\d|Table of Contents
stylenone

1. Overview

The AgGateway Digital Resources Development Process (DRDP) governs the process of producing and maintaining AgGateway’s Digital Resources.

2. Definitions

The following terms and definitions apply to this document and to the AgGateway Patent Policy [PATENT].

  • AgGateway Member: Any individual or organization that has joined AgGateway, as well as any employee or designated representative (e.g., contractor) of such organizations.

  • Call for Participation: A communication to AgGateway members that invites them to participate in a Working Group.

  • Collaborating Digital Resources Body: A Digital Resources body with which AgGateway has formal agreement. The form of the agreement could be reciprocal membership, letter-of-intent, memorandum of understanding, etc.

  • COO: AgGateway's Chief Operating Officer

  • CTO: AgGateway’s Chief Technology Officer

  • Digital Resource: Refers to any digital content developed with the intent of assisting companies with implementing electronic connectivity between systems and devices within their own company, and between their company and other companies. Digital Resource includes standards, guidelines, communications tools, project-management tools, implementation tools, and requirements or proposals passed on to a Collaborating Digital Resources Body.

  • Draft Revised Digital Resource: A digital resource that was initially produced by the DRC by copying a Digital Resource for the purposes of updating it.

  • DRC: AgGateway’s Digital Resource Center.

  • Member Submission: One or more documents developed outside of the AgGateway Digital Resources Development Process and Information about the documents, provided by the Submitter. See section 7.

  • PMC: AgGateway’s Portfolio Management Center

  • Proposed New Digital Resource: Any digital resource produced by a Working Group that the Working Group delivers to the DRC with the intent that the DRC will approve and publish it as a Digital Resource.

  • Proposers: One or more AgGateway Members who develop a Working Group charter and submit it to the COO.

  • Submitter: See section 7.

  • WG: Working Group

  • Working Group: An AgGateway organizational unit that produces Digital Resources.

3. Main Success Scenarios for High-Level Process Definitions

By main success scenario we mean a primary and exception-free process scenario. Greater detail is provided in the process diagrams in sections 4.

3.1 AgGateway Creates New Digital Resources

  1. Proposers develop a Working Group charter and submit it to the COO.

  2. The COO recommends charter approval and submits it to the AgGateway President.

  3. The AgGateway President approves the charter and communicates approval to the COO.

  4. The COO communications approval to the Proposers.

  5. The COO issues a Call for Participation.

  6. Interested AgGateway Members respond to the Call for Participation by affirmatively joining the Working Group.

  7. The COO convenes the first meeting of the Working Group during which a Working Group Chair, Vice Chair, and other charter-specified roles are selected.

  8. The Working Group conducts its work in accordance with the charter.

  9. At any point the Working Group has produced a deliverable that it determines is ready to be delivered to the DRC, it does so via the PMC. At this point the DRC has a Proposed New Digital Resource.

  10. The DRC reviews the Proposed New Digital Resource.

  11. The DRC approves the Proposed New Digital Resource in a meeting in which the CTO participates.

  12. The DRC determines whether or not a public review period is in the best interest of its membership, and if so, conducts one. The CTO may override a decision by the DRC to not conduct a public review, in which case AgGateway conducts a public review. In the event that the Collaborating Digital Resources Body conducts a public review as part of its process, the CTO may adjust the process specified in section 3.1 in order to conduct a coordinated public review with the Collaborating Digital Resources Body with the objective of reducing the overall elapsed time to publication.

  13. The DRC publishes the Proposed New Digital Resource as a Digital Resource.

3.2. AgGateway Updates Existing Digital Resource

  1. One or more AgGateway Members (Proposers) delivers a written proposal to change an existing Digital Resource to the DRC.

  2. The DRC reviews the proposal.

  3. The DRC approves the proposal in a meeting in which the CTO participates. The CTO may determine that such an update should be developed in the context of a WG, effectively following the process specified in section 3.1, obviating the remaining steps in this section.

  4. The DRC updates the applicable Draft Revised Digital Resource.

  5. The DRC publishes the Draft Revised Digital Resource as a Digital Resource.

3.3. AgGateway Maintains a Digital Resource

See section 5.

3.4. AgGateway Produces and Delivers Digital Resources to Collaborating Digital Resources Bodies

  1. AgGateway follows either process 3.1 or 3.2 as appropriate.

  2. CTO delivers one or more Digital Resources to a Collaborating Digital Resources Body. (The CTO may accomplish this task through a liaison to the Collaborating Digital Resources Body designated by the CTO.)

  3. CTO, in consultation with the DRC, monitors the progress of the delivered Digital Resource through the collaborating Digital Resources body and updates the Digital Resource's online publication description. (For example, if the Digital Resource has been incorporated in a published content by the collaborating Digital Resources body, then that should be noted online and perhaps the Digital Resource in the context of an AgGateway resource perhaps should be deprecated in favor of the published content by the collaborating Digital Resources body.

4. "AgGateway Creates New Digital Resource" Process Diagrams

4.1 High-Level

Plantumlcloudfilenamehigh-level.pngdata%40startuml%0A'%20PlantUML%20Activity%20Diagram%20Reference%3A%20https%3A%2F%2Fplantuml.com%2Factivity-diagram-beta%0Askinparam%20shadowing%20false%0A%7CPMC%7C%0Astart%0A%3ACharter%20WG%3B%0A%3ALaunch%20WG%3B%0A%7CWG%7C%0A%3AWork%3B%0A%7CDRC%7C%0A%3AProcess%20proposed%20DR%3B%0Astop%0A%40endumlwidthrevision6

4.2 AgGateway Charters WG

Plantumlcloud
filenameAgGateway_charter_wg.png
data%40startuml%0A'%20PlantUML%20Activity%20Diagram%20Reference%3A%20https%3A%2F%2Fplantuml.com%2Factivity-diagram-beta%0Askinparam%20shadowing%20false%0A%7CProposers%7C%0Astart%0A%3ADevelop%20WG%20charter%3B%0A%3ASubmit%20charter%20to%20COO%20via%20PMC%3B%0A%7CCOO%7C%0A%3AReview%20charter%3B%0A%3APass%20recommendation%20to%20President%3B%0A%7CPresident%7C%0A%3AApprove%2Freject%20charter%3B%0A%7CCOO%7C%0A%3AReport%20outcome%20to%20proposers%20via%20PMC%3B%0A%7CProposers%7C%0Astop%0A%40enduml
width
compressedfalse
revision2

4.3 AgGateway Launches WG

Plantumlcloud
filenameAgGateway_launch_WG.png
datahVBNa8MwDP01ZqeMkHTs7GW0DFZaNsbOaqIk2hw52GpK//3kei27DQx+kt6HbLMqo0CQ4+RMae9MVe4dsHxsXxXaVmghOSt8JhgCTIresMeA3KKprZajyBwvcK1nTmL1um+9ctfwa1B0WV4cUEBz4jfxDNkvjtD5E/GguAcXUefmsbHDBgRPcDYPDW9xOmCI2s7DZrfL+LJ76tX2JcYjqkez3pv66V+T2tq+pzCBboguPfHLE+v1ubnJbzHKbjwvyCmAmITAKZoQJS1+5av0Sn9Hh61ku6psR6BgqkbhQi0Wf2rgLi3nZcSQmUEwFB32xNhpZ/ZR8zzHHBPFzyliVSJ3+tM/
width
compressedtrue
revision4

4.4 WG Works

Plantumlcloud
filenameWG_work.png
dataZZBBa8MwDIV/jdmpIzQdPWcJ3WWFEBg7q7aamLl2sNWU/fs9O2GXgrGfrKdPQupQJaEo95tTVfOi9lXvyMvX+ROy0WIXK7+QnaUx0g1q4CtH9ppV3SCcROZU5AlnzsVgveoA74k2wM6s5bsLC6FP+rF+ppWXJjLhYf0IfSWXGHl1bL8/cGVrni5/1U0fg7mj774y7OzCkS6OE0Lr1VvrSesQDfnieFiZ8MiUAz2BwVHV7yuoW8ufQRK2GuC6oUWwWPrH9Od2QxzbnC3zATewZlCecZQyCGPPIbEpWxytkCtbTOEeNWyFmCTMGXao2Bvs7w8=
width
compressedtrue
revision4

4.5 AgGateway Process Proposed DR

Plantumlcloud
filenameAgGateway_process_proposed_DR.png
data%40startuml%0A'%20PlantUML%20Activity%20Diagram%20Reference%3A%20https%3A%2F%2Fplantuml.com%2Factivity-diagram-beta%0Askinparam%20shadowing%20false%0Askinparam%20BoxPadding%20100%0A%7CStandards%20%26%20Guidelines%5CnCommittee%7C%0Astart%0A%3AReview%20the%20Proposed%20DR%3B%0Aif%20()%20then%20(Questions%2Fissues%5Cnmust%20be%20addressed)%0A%20%20%3ADocument%20issues%2Fquestions%3B%0A%20%20%3ASend%20Proposed%20DR%20and%20documented%5Cnissues%2Fquestions%20back%20to%20the%5Cnproposing%20WG%20via%20the%20DRC%20and%5CnPMC%20to%20address%3B%0A%20%20stop%0Aelse%20(%2F%2F)%0A%20%20%3ADetermine%20whether%20a%5Cnmember%20review%20would%5Cnbenefit%20members%3B%0A%20%20if%20()%20then%20(Member%20review%5Cnwould%20benefit%5Cnmembers)%0A%20%20%20%20%3AConduct%20a%20member%20review%3B%0A%20%20else%20(%2F%2F)%0A%20%20endif%0A%20%20%3APublish%20Proposed%20DR%3B%0A%20%20stop%0Aendif%0A%40enduml
width
revision3

5. Producing Derived and Maintaining Existing Digital Resources

Some Digital Resources are derived from other resources or require ongoing maintenance. Examples include, but are not limited to code lists, controlled vocabularies, glossaries, data dictionaries, and OAGIS-profile resources. By default, each existing Digital Resource is subject to the process specified in section 3.2. The AgGateway CTO shall explicitly designate Digital Resources as qualifying for derivation or maintenance and therefore being subject to the following process:

  1. The AgGateway CTO explicitly designates a Digital Resource as derived or maintained.

  2. The DRC shall develop a derivation or maintenance process, which shall include approval and publication.

6. Delivering Digital Resources to Collaborating Digital Resources Bodies

Follow the "AgGateway Creates New Digital Resources" with the understanding that "Proposed Digital Resource" may not be for publication, but for delivery to a collaborating Digital Resources body (see the last activity "Publish Proposed Digital Resource as a Digital Resource"), or both.

7. Member Submission Process

The Member Submission process allows AgGateway Members to propose technology or other ideas to the COO for consideration by a Working Group. After a COO review, he/she MAY post the material in the associated Working Group's wiki space. The formal process affords AgGateway Members a record of their contribution and gives them a mechanism for disclosing the details of the transaction with the Working Group (including IPR claims).

A Member Submission consists of:

  • One or more documents developed outside of the AgGateway Digital Resources Development Process, and

  • Information about the documents, provided by the Submitter.

One or more AgGateway Members (called the "Submitter(s)") MAY participate in a Member Submission. Only AgGateway Members MAY be listed as Submitter(s).

The Submission process consists of the following steps:

  1. One of the Submitter(s) sends a request to the COO to acknowledge the Submission request. The COO and Submitter(s) communicate to ensure that the Member Submission is complete.

  2. After COO review, the COO MUST either acknowledge or reject the Submission request.

  • If acknowledged, the Working Group MUST publish the Member Submission in the Working Group wiki space.

  • If rejected, the Submitter(s) MAY appeal to either the AgGateway President or the AgGateway Board of Directors.

Note: To avoid confusion about the Member Submission process, please note that:

  • The Submission process is not a means by which AgGateway Members ask for "ratification" of these documents as Digital Resources.

  • There is no requirement or guarantee that technology which is part of an acknowledged Submission request will receive further consideration by AgGateway (e.g., by a Working Group).

Posting of a Member Submission to a Working Group wiki space does not imply endorsement by AgGateway staff, AgGateway Members, or Working Group. The acknowledgment of a Submission request does not imply that any action will be taken by AgGateway. It merely records publicly that the Submission request has been made by the Submitter. A Member Submission MUST NOT be referred to as "work in progress" of AgGateway.

7.1 Submitter Rights and Obligations

When more than one Member jointly participates in a Submission request, only one Member formally sends in the request. That Member MUST copy each of the Primary Contacts of the other participating AgGateway Members, and each of those Primary Contacts MUST confirm (by email to the COO) their participation in the Submission request.

At any time prior to acknowledgment, any Submitter MAY withdraw support for a Submission request (described in "How to send a Submission request"). A Submission request is "withdrawn" when no Submitter(s) support it. The COO MUST NOT make statements about withdrawn Submission requests.

Prior to acknowledgment, the Submitter(s) MUST NOT, under any circumstances, refer to a document as "submitted to AgGateway" or "under consideration by AgGateway" or any similar phrase either in public or AgGateway Member communication. The Submitter(s) MUST NOT imply in public or AgGateway Member communication that AgGateway is working (with the Submitter(s)) on the material in the Member Submission. The Submitter(s) MAY publish the documents in the Member Submission prior to acknowledgment (without reference to the Submission request).

After acknowledgment, the Submitter(s) MUST NOT, under any circumstances, imply AgGateway investment in the Member Submission until, and unless, the material has been adopted as a deliverable of an AgGateway Working Group

7.1.1 Scope of Member Submissions

When a technology overlaps in scope with the work of a chartered Working Group, AgGateway Members should participate in the Working Group and contribute the technology to the group's process. The Working Group MAY incorporate the contributed technology into its deliverables.

On the other hand, while AgGateway Members are in the early stages of developing a charter, AgGateway Members should use the Submission process to build consensus around concrete proposals for new work.

Members should not submit materials covering topics well outside the scope of AgGateway's mission.

7.1.2 Information Required in a Submission Request

The Submitter(s) and any other authors of the submitted material MUST agree that, if the request is acknowledged, the documents in the Member Submission will be subject to the AgGateway Document License [LICENSE] and will include a reference to it. The Submitter(s) MAY hold the copyright for the documents in a Member Submission.

The request MUST satisfy the Member Submission licensing commitments of section 3.3 of the AgGateway Patent Policy [PATENT].

The Submitter(s) MUST include the following information:

  • The list of all submitting Members.

  • Position statements from all submitting Members (gathered by the Submitter). All position statements MUST appear in a separate document.

  • Complete electronic copies of any documents submitted for consideration (e.g., a technical specification, a position paper, etc.) If the Submission request is acknowledged, these documents will be posted by the COO to the associated Working Group's wiki page. Submitters MAY hold the copyright for the material contained in these documents, but when posted by AgGateway, these documents MUST be subject to the provisions of the AgGateway Document License [LICENSE].

The request MUST also answer the following questions.

  • What proprietary technology is required to implement the areas addressed by the request, and what terms are associated with its use? Again, many answers are possible, but the specific answer will affect the COO's decision.

  • What resources, if any, does the Submitter intend to make available if the COO acknowledges the Submission request and takes action on it?

  • What action would the Submitter like AgGateway to take if the Submission request is acknowledged?

  • What mechanisms are there to make changes to the specification being submitted? This includes, but is not limited to, stating where change control will reside if the request is acknowledged.

7.2 Submitter Rights and Obligations

The documents in a Member Submission MUST fulfill the requirements specified by the COO (as of this writing requirements are not specified).

The COO sends a validation notice to the Submitter(s) once the he/she has reviewed a Submission request and judged it complete and correct.

Prior to a decision to acknowledge or reject the request, the request is AgGateway staff-only, and the AgGateway staff MUST hold it in the strictest confidentiality. In particular, the AgGateway staff MUST NOT comment to the media about the Submission request.

7.3 Acknowledgment of a Submission Request

The COO acknowledges a Submission request by sending an announcement to the AgGateway Board of Directors. Though the announcement MAY be made at any time, the Submitter(s) can expect an announcement within 14 days after the validation notice. The COO MUST keep the Submitter(s) informed of when an announcement is likely to be made.

Once a Submission request has been acknowledged, the COO MUST:

  • Publish the Member Submission.

  • Publish COO comments about the Submission request.

If the Submitter(s) wishes to modify a document published as the result of acknowledgment, the Submitter(s) MUST start the Submission process from the beginning, even just to correct editorial changes.

7.4 Rejection of a Submission Request

The COO MAY reject a Submission request for a variety of reasons, including any of the following:

  • The ideas expressed in the request overlap in scope with the work of a chartered Working Group, and acknowledgment might jeopardize the progress of the group.

  • The IPR statement made by the Submitter(s) is inconsistent with the AgGateway's Patent Policy [PATENT], Document License [LICENSE], or other IPR policies.

  • The ideas expressed in the request are poor or run counter to AgGateway's mission.

  • The ideas expressed in the request lie well outside the scope of AgGateway's mission.

In case of a rejection, the COO MUST inform the AgGateway Board of Directors, the Submitter(s), and Primary Contacts of the Submitter(s). The COO MUST provide rationale about the rejection. Other than to the aforementioned parties, the COO MUST NOT make statements about why a Submission request was rejected.

The Primary Contacts associated with the Submitters(s) MAY appeal the rejection to the AgGateway Board of Directors. At the time an appeal is made, the AgGateway President will establish a process for such appeals that ensures the appropriate level of confidentiality.

8. Definition of Normative, Optional and Informative

For purposes of this definition, the normative portions of the Digital Resource shall be deemed to include only architectural and interoperability requirements. Optional features in the RFC 2119 [KEYWORDS] sense are considered normative unless they are specifically identified as informative. Implementation examples or any other material that merely illustrate the requirements of the Digital Resource are informative, rather than normative.

Appendix A: AGIIS Exemption

The process specified in this document does not apply to AGIIS maintenance and development.

Appendix B: ADAPT Exemption

The process specified in this document does not apply to ADAPT maintenance and development.

Appendix C: Fast-Track Digital Resource-Development Exception

Activity duration (e.g., member review duration) specified in this document may be reduced according to the following process:

  1. A Working Group members proposes a reduction in one or more activity durations.

  2. The Working Group chair conducts a vote and the vote result is that all Working Group members have voted and each vote is affirmative.

  3. The Working Group chair submits the approved change to the COO.

  4. The COO may suggest adjustments.

    1. If the COO suggests adjustments, the Working Group chair may take the changes back to the Working Group for a vote (step 2) or reject the adjustments.

  5. The COO will present the proposed changes to the AgGateway Operational Board.

  6. The AgGateway Operational Board will approve or reject the proposal. In any case, the COO will report the outcome to the Working Group chair.

References

Anchor
KEYWORDS
KEYWORDS
[KEYWORDS]

Key words for use in RFCs to Indicate Requirement Levels, S. Bradner. The Internet Society, March 1997. This RFC is available by FTP at ftp://ftp.rfc-editor.org/in-notes/rfc2119.txt.

Anchor
PATENT
PATENT
[PATENT]

AgGateway Patent Policy, J. Wilson, Editor. AgGateway, . The latest version of this document is https://aggateway.atlassian.net/wiki/x/EgL5RQ.

Anchor
LICENSE
LICENSE
[LICENSE]

AgGateway Document License, J. Wilson, Editor. AgGateway, . The latest version of this document is https://aggateway.atlassian.net/wiki/x/NACQBQ.

Acknowledgments

Significant portions of this document is derived from the World Wide Web Consortium Process Document available at https://www.w3.org/2019/Process-20190301/. Various license requirements apply, which are met by including the following statement, with associated links, from the W3C:

W3C liabilitytrademarkdocument use and software licensing rules apply.