+1 Lynn Floyd [email protected] Anderson County Library 864-260-4500 x181 http://www.andersonlibrary.org
-----Original Message----- From: [email protected] [mailto:[email protected]] On Behalf Of Joe Sent: Thursday, August 01, 2013 2:30 PM To: Documentation discussion for Evergreen software Subject: [OPEN-ILS-DOCUMENTATION] ***SPAM*** Re: Including technical information in end-user docs I would give a +1 to what Tony and Jim said. It would be useful to have as much of the info in one place as possible. Perhaps the more technical info could be in foot notes if some are worried about less tech savvy library staff getting bogged down in it when they're using the docs? From my stand point, the folks who would have gotten bogged down with it here were the ones who relied more on hand on practice with Evergreen rather than reading the docs.. (ie, very few of my staff accessed the end user docs when we migrated. I used them to create training lesson plans and exercises, and they got comfortable practicing on our installation..). Thanks. Joe Joseph Knueven Director Germantown Public Library 51 N. Plum St. Germantown, OH 45327 937-855-4001 [email protected] On 8/1/2013 2:14 PM, James Keenan wrote: > I prefer having the information all in one place. When I was first learning > to install Evergreen (and before a bunch of doc work was done), it seemed > pretty inconvenient for me to search around for various bits of knowledge > here and there in different docs on the same topic. > > Jim > > Jim Keenan > Library Applications Supervisor > [email protected] > 508-755-3323 x23 > > C/W MARS > 67 Millbrook St., Suite 201 > Worcester, MA 01606 > > ? Save a tree! Please don't print this e-mail unless it's really necessary. > Currently reading Zen at War by Brian Victoria > Just finished World War Z by Max Brooks > > -----Original Message----- > From: [email protected] > [mailto:[email protected]] On Behalf > Of Kathy Lussier > Sent: Thursday, August 01, 2013 2:03 PM > To: Documentation discussion for Evergreen software > Subject: [OPEN-ILS-DOCUMENTATION] Including technical information in end-user > docs > > Hi all, > > This question came up during some recent discussions I had with Equinox > regarding some documentation they were doing for one of our development > projects, and it seemed like a topic that DIG might want to discuss. It > relates to how much technical documentation should be included in the > end-user docs that are created for a feature in Evergreen. In this case, it > is a new feature, but I suppose the question relates to any functionality we > want to document for Evergreen. > > We've seen documentation come in various forms when a new feature is > introduced: > > * The release notes include a description of the new feature and, ideally, > also include any new settings or permissions associated with the feature. > * The docs include information for end users to use the new feature. It also > sometimes contains information on settings and permissions. > * There is also a TechRef directory that is available with the code that > contains more technical information on some features. > > The question is how much technical information should be included in those > end-user docs? > > My personal opinion is that any information in the Release Notes should also > be included in the docs because there are many people who probably never look > at the release notes. However, should end-user docs include information on > library settings and permissions that are usually configured by the admin, > not the end-user? Should a separate technical details section be included in > the end-user docs? > > What structure do you think would work best for the community? > > Kathy > > -- > Kathy Lussier > Project Coordinator > Massachusetts Library Network Cooperative > (508) 343-0128 > [email protected] > Twitter: http://www.twitter.com/kmlussier > > _______________________________________________ > OPEN-ILS-DOCUMENTATION mailing list > [email protected] > http://list.georgialibraries.org/mailman/listinfo/open-ils-documentation > _______________________________________________ > OPEN-ILS-DOCUMENTATION mailing list > [email protected] > http://list.georgialibraries.org/mailman/listinfo/open-ils-documentation _______________________________________________ OPEN-ILS-DOCUMENTATION mailing list [email protected] http://list.georgialibraries.org/mailman/listinfo/open-ils-documentation _______________________________________________ OPEN-ILS-DOCUMENTATION mailing list [email protected] http://list.georgialibraries.org/mailman/listinfo/open-ils-documentation
