[OPEN-ILS-DOCUMENTATION] draft terms of reference

[Karen Schneider]

Sarah, I had the same reaction (to calling this "Terms of Reference"). I am
unfamiliar with the phrase and would recommend striking it from the
document.

I like the changes from Robin and Sarah. I am a big fan of clear and direct
(as well as consistent voice) and "uses DocBook for text-based documents"
meets that goal. I do wonder if we should not be just a little more
descriptive here (I am showing my investment here, I realize), and go for
"Uses DocBook 5.0, an XML-based, OASIS-approved documentation standard, for
all text-based documentation."

DocBook 6 is not anywhere on the horizon, and 5 just got approved. There's a
world of different between 4 and 5 (the movement away from DTD statements
and toward Relax NG is big) and it shows we are au courant in the
documentation standards arena. :)

Karen

On Wed, Aug 26, 2009 at 4:29 PM, <sarahc at zionsville.lib.in.us> wrote:

> I copied the "terms of reference" below and added asterisks anywhere I
> made a change. Terms of references sounds like a glossary to me, is that a
> common term for this?  Also, I’m not crazy about the use of the word
> “duplicative,” but I couldn’t come up with an alternative I liked much
> better.
>
> Sarah
>
>
>
> Mission Statement
> The Evergreen Documentation Interest Group (DIG) plans, facilitates,
> produces, manages, and provides access to online documentation about *the
> Evergreen *ILS.
>
>
> Scope
>
> *The DIG:
>
> Administers a framework for documentation, inclusive of timelines, a style
> guide, software tools, and DIG member training and support
>
> Produces reference and training documentation for standard implementations
> (not locally customized software), in multiple formats, for developers,
> system administrators, library managers, library staff, library users, and
> sites considering implement*ation
>
> Connects users to documentation via posting standard documentation on DIG
> web pages, linking out to community documentation, incorporate*ing help
> into the staff client, and fostering in-code documentation
>
> Manages the Evergreen documentation email list and the DIG web pages
>
> Does not provide technical support for Evergreen
>
> Principles
>
> *The DIG:
>
> Operates with wide participation and open communication, plans for its
> long-term sustainability, and is responsive to community need
>
> Manages documentation via single-sourcing, a central repository, version
> control, and the use of broader standards and best practices. *Uses
> DocBook for text-based documents
>
> Provides current historical standard documentation that is free and open,
> has cohesive structure and style, is easy for users to find and use, and
> is easy to maintain and translate
>
> Fosters collaboration, minimization of duplicative work, and the inclusion
> of documentation as part of the software development process
>
>
>
>
> > Shannon and I now have a draft terms of reference to show you all. It is
> > at
> >
> http://evergreen-ils.org/dokuwiki/doku.php?id=evergreen-docs:dig_terms_of_reference
> ,
> > and includes a mission statement, scope, and principles. Comment away!
> > I'll also put this on the agenda for the next DIG meeting.
> >
> > Paul
> >
> > _______________________________________________
> > OPEN-ILS-DOCUMENTATION mailing list
> > OPEN-ILS-DOCUMENTATION at list.georgialibraries.org
> > http://list.georgialibraries.org/mailman/listinfo/open-ils-documentation
> >
>
>
> Sarah Childs
> Senior Cataloger
> Hussey-Mayfield Memorial Public Library
> Zionsville, Indiana
> 317-873-3149 ext. 13330
>
>
> _______________________________________________
> OPEN-ILS-DOCUMENTATION mailing list
> OPEN-ILS-DOCUMENTATION at list.georgialibraries.org
> http://list.georgialibraries.org/mailman/listinfo/open-ils-documentation
>



-- 
-- 
| Karen G. Schneider
| Community Librarian
| Equinox Software Inc. "The Evergreen Experts"
| Toll-free: 1.877.Open.ILS (1.877.673.6457) x712
| kgs at esilibrary.com
| Web: http://www.esilibrary.com
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://list.georgialibraries.org/pipermail/open-ils-documentation/attachments/20090827/a9149a65/attachment.htm