This is an old revision of the document!
Table of Contents
How to Participate in the Evergreen Documentation Interest Group
Contributing to documentation is an excellent way to support Evergreen, even if you are new to documentation. 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, converting to AsciiDoc, and other tasks. Whatever your background or experience we are keen to have your help!
First Steps
- 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.
- Check out the newest documentation to-do list to see which areas need work, and mention on the listserv which areas you're interested in working on. For large chunks of documentation you may want to see if there are other people who would like to team up with you.
- Write documentation in any format and send it to the documentation email list. We will review your files, convert them to AsciiDoc format and add them to the official documentation when they are ready.
- If you are comfortable with AsciiDoc formatting, you can contribute documentation directly.
Volunteer roles
We are now looking for people to help produce the documentation. If you interested in participating, email the DIG facilitators at docs@evergreen-ils.org or speak up on the documentation mailing list.
We're looking for volunteers to work on the following:
Writing – Producing the documentation ("from scratch," and/or revised from existing materials). We're open to receiving content in any formats, such as Word or Open Office, but of course, we'd be delighted if you produced it in AsciiDoc!
- User Guide – Detailed guide for AsciiDoc syntax. (methods.co.nz)
- Cheat Sheet – Quick reference for AsciiDoc formatting. (methods.co.nz)
Testing – Comparing the documents with the functions they describe
AsciiDoc conversion – For existing files that are not already in AsciiDoc, and new ones created by people writing in other formats
Editorial review – Ensuring the documentation is clear and follows Evergreen DIG style guide conventions
CSS Design – Making the pages more attractive and user-friendly