DAP4: Design Proposal Process: Difference between revisions

From OPeNDAP Documentation
⧼opendap2-jumptonavigation⧽
No edit summary
No edit summary
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
[[Development#OPULS_Development | <-- back to OPULS Development]]
''James Gallagher''


''James Gallagher''
[[OPULS_Development | << back to OPULS Development]]


== Background ==
== Background ==
We need a formal process for presenting and discussing proposals for the DAP4 design. It should be easy to use and accommodate the ideas/proposals we already have. It should also provide a way to preserve the important points of the discussions we have regarding the proposed idea. This doesn't mean that the entirety of the discussion should be included, often there is too much noise there to render that kind of material useful several month hence, but the main points should be preserved. Some of the proposals will very likely resolve themselves to tradeoffs where no choice is optimal and it will be very helpful to be able to return to the motivations for our decisions.
We need a formal process for presenting and discussing proposals for the DAP4 design. It should be easy to use and accommodate the ideas/proposals we already have. It should also provide a way to preserve the important points of the discussions we have regarding the proposed idea. This doesn't mean that the entirety of the discussion should be included, often there is too much noise there to render that kind of material useful several month hence, but the main points should be preserved. Some of the proposals will very likely resolve themselves to tradeoffs where no choice is optimal and it will be very helpful to be able to return to the motivations for our decisions.


== Proposed Process ==
== Proposed Process ==
For Design Proposals, I propose these steps:
For Design Proposals, I propose these steps:


Line 17: Line 15:
#* Rationale for the solution;  
#* Rationale for the solution;  
#* Discussion
#* Discussion
# Ideas can be considered as ''Proposals'' if the entire group agrees (or at least if there are no people who object)
# We will put these ideas under the subsection titled ''Proposals''
# We will keep the number of proposals actively under discussion to a minimum - ideally just one - but realize that several proposals might be interrelated so discussing then separately could be counter productive.  
# Each proposal is listed in that subsection two parts:
# We will discuss the proposal to determine if it is acceptable. We will use email or an email list for most of the discussion, but the conclusions of the discussion should be captured on the wiki page that contains the proposal.
#* a pointer to a page containing the proposal
# Proposals can be adopted when we all agree on them, or they can be discarded if we all agree on that.
#* a tag/annotation indicating the state of the proposal.
# The possible states for a proposal will be:
#; New : there can be any number of these
#; Under Consideration : there can be at most one of these  as chosen by James or by consensus.
#; Accepted : any number, but only so tagged after consideration and consensus acceptance.
#; Declined : any number, if after consideration the proposal is not accepted
#; Under Revision : any number if after consideration, it is deemed to need further work.
 
For discussion, we will use email (or an email list if needed) for most of the discussion, but the conclusions of the discussion should be captured on the wiki page that contains the proposal.


Notes:
Notes:
* I have a very simple template for the ideas at [[Template:DAP4 Design Proposal]]. The easiest way to use it is to use the ''<nowiki>{{subst: DAP4 Design Proposal}}</nowiki>'' syntax to include the template. We might add to this template over time.
* I have a very simple template for the ideas at [[Template:DAP4 Design Proposal]]. The easiest way to use it is to use the ''<nowiki>{{subst: DAP4 Design Proposal}}</nowiki>'' syntax to include the template. We might add to this template over time.
* If the new wiki pages all start with the prefix ''DAP4:'' that will help organize the content and will automatically add all of the pages to the ''DAP4'' category. To explicitly add a page to that, or another, category, use the syntax ''<nowiki>[[Category:DAP4|<<page name>>]]</nowiki>''.
* If the new wiki pages all start with the prefix ''DAP4:'' that will help organize the content and will automatically add all of the pages to the ''DAP4'' category. To explicitly add a page to that, or another, category, use the syntax ''<nowiki>[[Category:DAP4|<<page name>>]]</nowiki>''.

Latest revision as of 22:48, 2 March 2012

James Gallagher

<< back to OPULS Development

Background

We need a formal process for presenting and discussing proposals for the DAP4 design. It should be easy to use and accommodate the ideas/proposals we already have. It should also provide a way to preserve the important points of the discussions we have regarding the proposed idea. This doesn't mean that the entirety of the discussion should be included, often there is too much noise there to render that kind of material useful several month hence, but the main points should be preserved. Some of the proposals will very likely resolve themselves to tradeoffs where no choice is optimal and it will be very helpful to be able to return to the motivations for our decisions.

Proposed Process

For Design Proposals, I propose these steps:

  1. Anyone can write up a new idea and add it to the wiki. It would be best if the ideas are presented using the following format:
    • Background;
    • Problem addressed;
    • Proposed solution;
    • Rationale for the solution;
    • Discussion
  2. We will put these ideas under the subsection titled Proposals
  3. Each proposal is listed in that subsection two parts:
    • a pointer to a page containing the proposal
    • a tag/annotation indicating the state of the proposal.
  4. The possible states for a proposal will be:
    New
    there can be any number of these
    Under Consideration
    there can be at most one of these as chosen by James or by consensus.
    Accepted
    any number, but only so tagged after consideration and consensus acceptance.
    Declined
    any number, if after consideration the proposal is not accepted
    Under Revision
    any number if after consideration, it is deemed to need further work.

For discussion, we will use email (or an email list if needed) for most of the discussion, but the conclusions of the discussion should be captured on the wiki page that contains the proposal.

Notes:

  • I have a very simple template for the ideas at Template:DAP4 Design Proposal. The easiest way to use it is to use the {{subst: DAP4 Design Proposal}} syntax to include the template. We might add to this template over time.
  • If the new wiki pages all start with the prefix DAP4: that will help organize the content and will automatically add all of the pages to the DAP4 category. To explicitly add a page to that, or another, category, use the syntax [[Category:DAP4|<<page name>>]].
Retrieved from "https://docs.opendap.org/index.php?title=DAP4:_Design_Proposal_Process&oldid=7467"