[OPEN-ILS-DOCUMENTATION] Proposed Goal for documenting new features

Remington Steed rjs7 at calvin.edu
Wed Apr 9 13:30:45 EDT 2014


Hi DIG,

I have added the following to this week's meeting agenda.  What do you think?  I would love to see DIG gain some traction and get into a regular rhythm of documenting new features before they are released.  What will help us move in that direction?  These are my ideas, but please feel free to share your ideas too.  Maybe at this week's meeting we can choose a direction and give it a try.

Proposed goal (by Remington): Document all new 2.6 features by July 1, and all new future version features by the time the version is released.

  1.  We could accomplish this by adopting a simple workflow, where each active DIG member commits to document 1-3 features per month (from a list like the 2.5 needs list<http://evergreen-ils.org/dokuwiki/doku.php?id=evergreen-docs:2.5_needs>) and report on progress at each monthly meeting. We may also want to meet more frequently (twice a month?).
  2.  I have created a draft of a 2.6 Docs Needs<http://evergreen-ils.org/dokuwiki/doku.php?id=evergreen-docs:2.6_needs> page.
  3.  To ease the burden on us and improve speed and understanding, we should partner with the developer(s) of new features as much as possible.
  4.  All older features that need to be documented should be part of the DIG workflow too, but maybe secondary. Perhaps when an EG version begins the Alpha phase we shift focus to new features until the final release, and then we shift focus back to older features that need work.
--
Remington Steed
Electronic Resources Specialist
Hekman Library, Calvin College
http://library.calvin.edu/

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://list.georgialibraries.org/pipermail/open-ils-documentation/attachments/20140409/d7f52988/attachment.htm>


More information about the OPEN-ILS-DOCUMENTATION mailing list