Archive for the ‘Evergreen Documentation’ Category

Evergreen Documentation Licensing Terms

Wednesday, January 13th, 2010

The Evergreen Documentation Interest Group (DIG) has voted to accept the following proposals for Evergreen Documentation Licensing. The vote took place December 21, 2009 – January 4, 2010 on the Documentation Interest Group Mailing List. There were 18 yes votes and 0 no votes, for a unanimous decision.

Since these licensing terms affect the entire Evergreen community, and particularly anyone who has contributed to the Documentation Wiki, we wanted to keep everyone informed. Please take a moment to read the licensing terms below (also available on the wiki at http://evergreen-ils.org/dokuwiki/doku.php?id=evergreen-docs:documentation_licensing_terms). If you have previously contributed documentation to the Documentation Wiki and do NOT want your contributions to be licensed under these terms, please contact the DIG facilitators or the DIG mailing list and let us know that by Friday, January 29th.

I am crossposting this to several Evergreen related mailing lists and blogs, as well as sending an email about this to anyone with a DokuWiki account, so I apologize for duplicate messages. If you have any questions, feel free to contact the DIG facilitators at docs@evergreen-ils.org.

I hope you’ll agree that this is a positive step forward for the Evergreen community. And, if you find some free time, that you might consider joining the Documentation Interest Group in producing some community-wide documentation.

Thanks,
Karen Collier
Documentation Interest Group Co-Facilitator

1 – Official Evergreen Documentation produced by the Documentation Interest Group should be licensed under the Creative Commons Attribution Share-Alike 3.0 License (http://creativecommons.org/licenses/by-sa/3.0/).

2 – Any code included in the official documentation produced by the Documentation Interest Group should also be made available under the GNU GPL (http://www.gnu.org/licenses/gpl.html).

3 – Official Evergreen Documentation may be made available under another copy-left (http://www.fsf.org/licensing/essays/copyleft.html) open source (http://www.opensource.org/docs/osd) license in the future with a majority vote on the Evergreen Documentation List (open-ils-documentation@list.georgialibraries.org) or comparable indication of the Evergreen community’s wishes.

4 – These same licensing terms should be applied to the Documentation Wiki. Past contributors to the Documentation Wiki should be notified by emails sent to Evergreen community mailing lists and to the email address associated with their docuwiki account of the new licensing terms and given a reasonable amount of time to request that their contributions not be included under those licensing terms.

5 – By submitting documentation to the Documentation wiki or to the Evergreen Documentation List after licensing terms have been decided and publicized, contributors indicate that they (a) agree to these licensing terms, and (b) to the best of their knowledge have the right to do so through copyright ownership, permission from the copyright owner(s), and/or the licensing terms of any documents that were modified or incorporated into their submission.

Evergreen Documentation Needs Assessment Report

Wednesday, September 16th, 2009

High-level preliminary assessment from Evergreen Documentation Survey

Karen G. Schneider, Equinox Software, and Karen Collier, Kent County (Md.) Library

September, 2009

Recommendation

The needs assessment group of the Evergreen Documentation Interest Group (DIG) recommends that activities to produce single-source, XML-based project-wide Evergreen documentation commence immediately in these four areas: reports; installation, upgrading, and migrations; cataloging; and circulation. (Note: the DIG concurred at the September 9 meeting, and work has commenced.)

Discussion

The needs assessment functional workgroup of the Evergreen Documentation Group designed, tested, and then conducted a survey from August 12 through August 20, 2009. This was a wide-open survey, with no limits on who could respond, and was intended to be useful but not scientifically rigorous.

The survey had a predictably strong response in the first 24 hours after its announcement, typical of most online surveys, with 84 responses accrued within the first four days—a realistic and useful response rate. The following Monday, August 17, after another survey reminder, the survey experienced an unusually strong spike in response rates.

This second wave of responses, combined with other indicators, suggest that there may have been some “survey-loading” to ensure varied demographics were represented. This was actually not discouraged, and overall, these responses tend to cancel one another out. However, in some cases we took the “pre-wave” data (the 84 responses received before August 17) and give it further manipulation, then compared results. We also took a quick look at crosstabbed results, such as by status with Evergreen (running live, preparing to migrate, testing, actively evaluating, or considering).

Narrative Review of Responses

Responses: 273; 222 completed all applicable questions, for a completion rate of over 81%. Most respondents completed most of the questions (a more meaningful measure, since none of the questions were mandatory).

73% of respondents reported that they worked in a public library. Over 10% of respondents work in a library consortium. Respondents in academic and public libraries were asked to identify their library’s size. 45.7% said “medium,” though large libraries were almost 15% of the responses.

We encouraged a broadly representative response, which is what we got to the question, “What are your roles in your organization?” The top responses were from library circulation (48%), followed by administration (43%), cataloging and training (each 40%), but responses came from all over the spectrum — not only the 12 identified areas, but over 2 dozen other roles as well, from pages to outreach librarians to project managers.

Over 100 respondents were also in some technical role, such as system administration, technical support, or development. 91 respondents claimed to work in system administration (39 prior to 8/17).

Four out of five respondents were from organizations actively running Evergreen or preparing to migrate their first libraries. For those libraries running Evergreen, over 70% had been running Evergreen less than one year.

Priorities for Evergreen Documentation

Overall, 79% of respondents thought version 1.6 (versus earlier versions such as 1.4 or 1.2) should be the highest priority for centralized, Evergreen-wide documentation efforts. This did not significantly shift when compared by role.

Based on all responses, the top six priorities for first topics for Evergreen-wide documentation are:

Circulation 71.8% (153)
Cataloging 59.1% (123)
Reports 58.8% (120)
Installing, upgrading, migrating 50.5% (99)
Local administration 50.2% (102)
System administration 46.8% (94)

Based on the 84 responses received before August 13, the priorities are similar in most areas:

Installing, upgrading, migrating 69.8% (44)
Circulation 57.4% (39)
Local administration 58.5% (38)
System administration 63.1% (41)
Reports 52.3% (120)
Cataloging 51.5% (34)

The key point is that there were no drop-offs—all six topics remained the highest priorities, pointing to a clear mandate for practical, field-oriented documentation. (For example, there had been discussion in the community that online help in the OPAC may be a high priority, but this is not indicated as a high priority by the survey results.)

Furthermore, when results were crosstabbed with the respondent’s role, there were some predictable fluctuations. Migration was a high priority for close to 90% of those migrating to or running a test instance of Evergreen, while only a high priority of 50% of circulation staff.

Meanwhile, reports documentation was a high priority for 73.9% of respondents reporting that they were in libraries running Evergreen live in production, where presumably there is always a real-world need for running and manipulating reports, but for only 14.3% of respondents “actively evaluating Evergreen.”

Formats for documentation

Priorities were at 68.2% each for Web-based online documents and PDFs (over 90% for libraries running a test instance or actively evaluating Evergreen).

Overall, nearly half of all respondents (48%) indicated they would like to see context-sensitive help in the staff client, though this fluctuated widely by status with Evergreen, with a low of 42.9% from libraries running Evergreen to a high of 72.7% for libraries either actively evaluating or considering Evergreen.

On languages for documentation, 76.7% indicated a need for Spanish, while 20% asked for French, and Czech and Armenian received some votes as well.

The following question was based on the results of a (unanimous) vote at the Documentation Interest Group founding meeting in May, 2009: “We are considering implementing the ability for registered users to add comments to each section of the central online version of the documentation. How important is this feature?”

For the total survey, 21.1% (47) replied “Absolutely, please make this happen”; 64.6% (144) identified it as “A nice feature, when you can get around to it”; and 14.3% (32) indicated it was “not that important.”

The comment feature was rated even more highly by the early, pre-8/17 group; of them, 36.5% said “please make it happen,” and fewer than 5 percent thought it was “not that important.” This again fluctuated by status. 52% of the respondents from libraries running Evergreen rated this a “nice feature,” compared to 66.7% for libraries preparing to migrate and 81.8% for libraries actively evaluating Evergreen.

More Documentation Lurking in the Wild?

35 respondents indicated they had local documentation they would be willing to share with the Evergreen project (that had not been shared in the past), with responses in every category, ranging from web developers’ references to sysadmin and circulation. Their responses will be filtered against the contact information they provided in the survey.

Moving Forward

Finally, the best advice the DIG got was in one of the 39 responses in the final comments section: “Soldier on!”

Evergreen Documentation Survey: Please Take by 8-20-09

Wednesday, August 12th, 2009

The Evergreen Documentation Interest Group needs your input to help prioritize its activities for the next few months. Please take the following survey and share it widely. We are casting a wide net — we want input from as many roles as possible, from project coordinators to people working the front lines in libraries, and whether you are just thinking about Evergreen or running it since Day 1.

Responses are due no later than 5 p.m. ET Thursday, August 20, 2009. The survey is short and easy to complete.

You are encouraged to forward this to interested communities.

Thanks much on behalf of the Evergreen DIG!

Evergreen Documentation Interest Group: Can you DIG it?

Thursday, June 4th, 2009

This is a summary that was posted to the three Evergreen discussion lists (general, documentation, and development) about the exciting momentum gathering around Evergreen documentation.

The key take-away: the Evergreen community now has a Documentation Interest Group!  There will be an online meeting 3 p.m. Eastern Time Wednesday, June 10, to discuss initial roles and tasks — if you’re interested, sign up.

Most day-to-day discussions about the Evergreen documentation project will take place on the Evergreen documentation list (though news of note may be posted to this blog and other lists on occasion). To subscribe to open-ils-documentation (or other Evergreen lists), see http://evergreen-ils.org/listserv.php

More about the DIG Project
On Wednesday, May 20, 2009, at the Evergreen International Conference, close to two dozen members of the Evergreen community participated in a documentation planning discussion.

Following a presentation about documentation (see notes below), the group took the following actions and (unanimously) made the following commitments:

* Established an Evergreen Documentation Interest Group, aka DIG, or even, the DIGgers
* Agreed to meet regularly to plan and implement the Evergreen documentation project
* Agreed that core Evergreen documentation should be based on one single-source, standards-based, open format
* Agreed that DocBook was the format of choice for Evergreen documentation
* Agreed that community members could contribute documentation in any format, and the DIG would convert to DocBook format as required
* Agreed that the initial organizing meetings should clarify roles and tasks
* Agreed that Karen Schneider and Paul Weiss would lead this project at this point in time

Some of the earliest activities for the DIG will include establishing a timeline and a regular meeting schedule, and identifying initial tasks for project participants and recruiting for each role. Some of the preliminary groundwork for the project, once volunteers have committed to specific areas, will include identifying a core DocBook subset of tags for Evergreen documentation, writing an Evergreen style (markup) guide, developing heavily-annotated model templates, and providing toolset advice.

Documentation News of Note

The evergreen-ils.org website has been updated so that the Documentation list stands on its own, rather than being listed under Development. (See http://evergreen-ils.org/listserv.php )

Slides from the May 20 discussion are also on Slideshare. These slides spell out in greater detail why (and how) the Evergreen community is moving in this direction.  Questions? Post away!

http://www.slideshare.net/evergreenils/evergreen-docs-planning-session-2009 (full set)

http://www.slideshare.net/evergreenils/evergreen-documentation-lightning-talk (short set)