[OPEN-ILS-DOCUMENTATION] documented developmnt

[Kathy Lussier]

Hi Robert,

Thanks for opening up this discussion. Coming from an organization that has
recently contracted for development, we definitely are willing to commit to
providing documentation for any development we are sponsoring, although our
preference would be to write our own documentation rather than pay somebody
else to do it. My viewpoint is that we have to create that documentation for
our own users, so we might as well contribute it to the community at the
same time.

>  It would seem that these new features would have something 
> written somewhere -- even rough notes? Is there an economic 
> or contractual  reason why these cannot be shared with the 
> general Evergreen community at an earlier stage by either the 
> developers of the features, users of the new features or 
> trainers for the new features?

I don't see any reason why these can't be shared at various stages of the
project. For example, I wouldn't have a problem with sharing any approved
specs before development begins. However, all organizations are different,
and there may be others that have a reason for not sharing this information
- I can't think what that reason would be off the top of my head.

I don't see a problem with DIG sand others to trongly encourage
organizations that sponsor development to also be responsible for
documentation, but there may be some that, for whatever reason, may not be
able to create documentation or to pay for somebody else to do the
documentation. Despite what Grace just posted about Equinox's new policy,
there may be work done by other developers for which there isn't
documentation. 

In these cases, DIG would need to play a role. I'm thinking the new content
coordinator roles would need to include keeping on top of what enhancements
have been added to the system and what needs documentation. However, it
isn't always easy to stay on top of what development is happening. It would
be nice if there were a centralized place where we could see what new
development is in the works - I know the Web team has talked about this at
various times. I know it's long before the point when documentation is
actually required, but it would give documentors an idea of what the
enhancements are that need documenting. Having access to a community server
with the latest release is also a big plus in the effort to create
documentation for any new enhancements. 

Kathy Lussier


-------------------------------------------------------------
Kathy Lussier
Project Coordinator
Massachusetts Library Network Cooperative
(508) 756-0172
(508) 755-3721 (fax)
klussier at masslnc.org
IM: kmlussier (AOL & Yahoo)
Twitter: http://www.twitter.com/kmlussier
 
 
 

> -----Original Message-----
> From: 
> open-ils-documentation-bounces at list.georgialibraries.org 
> [mailto:open-ils-documentation-bounces at list.georgialibraries.o
> rg] On Behalf Of Soulliere, Robert
> Sent: Tuesday, February 08, 2011 1:34 PM
> To: open-ils-documentation at list.georgialibraries.org
> Subject: [OPEN-ILS-DOCUMENTATION] documented developmnt
> 
> Hi All,
> 
> During the DIG meeting Dan proposed that the DIG could 
> suggest to the Evergreen community that any new contracted 
> feature development should include docs to be submitted to 
> the DIG as part of the development. I wonder if we could 
> discuss this here and broaden the topic a bit to see if it is 
> possible to get  documentation on new features into the 
> official documentation more quickly?
> 
>  I would like to offer an open-ended question:
> 
> Is there  anything that DIG can do to help get documentation 
> on new features into official documentation as they are 
> developed so all organizations can get the information they 
> need to learn about and use the new features when the install 
> or upgrade Evergreen?
> 
>  It would seem that these new features would have something 
> written somewhere -- even rough notes? Is there an economic 
> or contractual  reason why these cannot be shared with the 
> general Evergreen community at an earlier stage by either the 
> developers of the features, users of the new features or 
> trainers for the new features?
> 
> Robert
> 
> Robert Soulliere, BA (Hons), MLIS
> Systems Librarian
> Mohawk College Library
> robert.soulliere at mohawkcollege.ca
> Telephone: 905 575 1212 x3936
> Fax: 905 575 2011
> 
> This E-mail contains privileged and confidential information 
> intended only for the individual or entity named in the 
> message.  If the reader of this message is not the intended 
> recipient, or the agent responsible to deliver it to the 
> intended recipient, you are hereby notified that any review, 
> dissemination, distribution or copying of this communication 
> is prohibited.  If this communication was received in error, 
> please notify the sender by reply E-mail immediately, and 
> delete and destroy the original message.
> _______________________________________________
> OPEN-ILS-DOCUMENTATION mailing list
> OPEN-ILS-DOCUMENTATION at list.georgialibraries.org
> http://list.georgialibraries.org/mailman/listinfo/open-ils-doc
> umentation
>