This is an old revision of the document!
Table of Contents
Evergreen Documentation Interest Group (DIG)
We welcome new participants and invite anyone interested to attend meetings, volunteer for tasks, and join the discussion lists. There's a role for everyone!
Activities of the DIG | Short-range Goals | How to Participate
Meeting Notes and Recordings | Participant Roster
Documentation Resources | DIG Scope and Mission | Email the DIG ——–
stuff to paste from
Evergreen Documentation Interest Group (DIG)
Get involved
Contributing to documentation is an excellent way to support Evergreen, even if you are a beginner. In fact, beginners often have a distinct advantage over the experts, more easily spotting the places where documentation is lacking or where it is unclear. We welcome your contribution with planning, writing, editing, testing, translating to DocBook, and other tasks. Whatever your background or experience we are keen to have your help!
What you can do now
- Join the Evergreen documentation listserv: http://list.georgialibraries.org/mailman/listinfo/open-ils-documentation. This is the primary way we communicate with each other. Please send an email introducing yourself to the list.
- Add yourself to the participant list if you have an Evergreen DokuWiki account, or send a request to docs@evergreen-ils.org.
- Review project resources.
- Edit current pages in the Documentation Wiki
- To request an account for this wiki, email docs@evergreen-ils.org
- Check out the current task list and contact the relevant people if you see something you'd like to help out with.
- You can find contact emails on the Participant list, or send a message on the listserv.
- Attend a DIG meeting.
Future roles
We will be needing:
- Writers—Even with all the great documentation that currently exist, there are still aspects of Evergreen which have not been covered. Once we have finished our environmental scan, we'll be putting together a list of topics that need covering.
- Editors—We will need people to make sure that the documentation follows our forthcoming style guide and is clear and consistent.
- DocBook editors—We will need people to transfer existing documentation to DocBook.
- Test Drivers—We will also need people to take the documentation out for a test drive and make sure it’s accurate, thorough and makes sense.
- Update Writers—When updates to the software occur, we will need people to update the documentation to reflect the changes in the software.
- People to get permissions—A lot of documentation has already been written. If you have rights to such material, granting DIG permission to adapt these for the project is a huge benefit. Likewise, if you are aware of existing documentation, convincing those with the rights to them to allow us to use them would also be useful.
- And more–It's a big project; we'll need help with things we haven't even thought of yet.
Meetings
We generally meet every two weeks using GoToMeeting. Karen or Paul will set up the meeting and announce it to the listserv. It is not necessary to attend the meetings to be involved with DIG.
Next meeting
To be scheduled for the second half of August: draft terms of reference
Past meetings
August 6, 2009: agenda, Recording (.wmv)
July 17, 2009: draft meeting notes, Recording (.wmv)
July 2, 2009: agenda, meeting notes, Recording (.wmv)
June 10, 2009: agenda, meeting notes, webinar recording, action items
May 20, 2009: (Documentation Hackfest at the 2009 Evergreen International Conference 2009): slides, handout, lightning talk report