[OOTB-addons] Documenting / organising acceptance criteria

[Axel Faust]

Hello all,

in the two weeks since Summit I have “played around” in our wiki (https://github.com/OrderOfTheBee/addons/wiki) trying out ways to document and organize any acceptance criteria we have for addons that we want to include in the collection. Currently, I have created a page for a “quick overview” of all criteria (https://github.com/OrderOfTheBee/addons/wiki/Inclusion-criteria-overview) and a couple of “sub-pages” that feature more detail in the description of requirements – and could potentially include examples of accepted vs. unaccepted constellations / behaviour in the future. These sub-pages are https://github.com/OrderOfTheBee/addons/wiki/Non-technical-inclusion-criteria and https://github.com/OrderOfTheBee/addons/wiki/Technical-inclusion-criteria for the moment, but may be further sub-divided when more content is included.

The overview should be easier to use as a checklist when we review any addons since you don’t have to interpret and mince with too much textual description. But I think we won’t get by without having a more detailed, descriptive version of the criteria catalog either as simple clarification or an argumentative basis when we discuss reviews with addon developers. If – in the long run – we engage with the Community in educating developers about aspects we consider “best practice”, this should allow us to easily expand a detailed description of a single rule / criterion into a dedicated HowTo / blog post.

The current content of these pages in regards to acceptance criteria reflects what I could think of to get started. Wherever possible I tried to keep the various comments from previous discussions in mind, but in the end, those contents are primarily intended as a plastic example.

Please take the time to review and share your thoughts.
As several people discussed at Summit, we need to keep the momentum of the Order in general going. I would like it if this meant we’ll have a first accepted draft of a criteria catalog sometime next month and start doing the first “prototype reviews” before Christmas holidays (and preparations) have everyone distracted for the rest of the year. Defining the “how” of criteria documentation is the first step…

Regards
Axel
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://www.xtreamlab.net/pipermail/ootb-addons/attachments/20141026/79e0d3e0/attachment.html>