[OPEN-ILS-DOCUMENTATION] Auto Suggest in Catalog Search documentation

[Soulliere, Robert]

Hi Sally,

I think this is a geat workflow. I wonder if ity would be possible in step 2 to also update the outline in orange indicating that documementation is completed and ready.

As well it might be good to provide link directly to the external documentation when it is ready for inclusion? There are a few reasons for this:

1. It allows us to quickly locate documentation . I know you will be indicating location vial the list, but in some cases, list messages might be missed --  I know I've missed messages in the past.
2. End users looking for documentation might find the external source via the outline while waiting for integration into official docs.
3. Publicity for the source or site providing the documentation. Might be good for online traffic -- if desired.
4. Helps us keep track of new sources to add to Attributions appendix as needed.

Another important note: We need to also consider communication when the documentation is updated on the external source and communicating that to DIG. The outline could also be used for this (adding a note in orange) as well as coordinating with Content Coordinators.

Thanks Sally and ESI for writing and sharing this documentation! It is extremely useful for using many of the new features.

Regards,
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
________________________________________
From: open-ils-documentation-bounces at list.georgialibraries.org [open-ils-documentation-bounces at list.georgialibraries.org] On Behalf Of Sally Fortin [sfortin at esilibrary.com]
Sent: May 13, 2012 3:43 PM
To: open-ils-documentation at list.georgialibraries.org
Subject: Re: [OPEN-ILS-DOCUMENTATION] Auto Suggest in Catalog Search    documentation

On 5/12/2012 8:51 AM, Soulliere, Robert wrote:

Hi Dan and Robert,

Thanks for better integrating the release notes and official
documentation this weekend.  Robert mentioned the need for a better way
to communicate that external documentation is ready for inclusion in
DIG's documentation and to coordinate official documentation and release
notes. Robert's suggestion of working with the content coordinators
makes sense to me.  Perhaps the workflow could be something like the
following:

1. Author includes proposed or in process documentation on wiki in blue
(http://open-ils.org/dokuwiki/doku.php?id=evergreen-docs_2.2:outline)
2. Author completes documentation and makes the documentation available
to appropriate open-ils mailing lists and (module) content coordinator
3. (Module) content coordinator merges the documentation with existing
documentation when necessary
4. (Module) content coordinator notifies docBook Conversion Coordinator
that documents are ready for inclusion in DIG documentation
5. DocBook Conversion Coordinator merges the documentation and updates
the needed documentation wiki in green to indicate that the
documentation is complete

Adding release notes:

1. Original author (or anyone else) sees that documentation has been
added to DIG documentation and writes summary for release notes or an
author just decides to write the summary independent of external
documentation
2. Author notifies DIG Release Coordinators and Content Coordinators
that release notes have been added
3. DIG Release Coordinator contacts DocBook Conversion Coordinator to
create a hyperlink between release notes and DIG documentation
4. DocBook Conversion Coordinator updates wiki to indicate that the
process for that section of release notes is complete?

Thoughts?

Thanks,
Sally
> I wonder if in the future, whenever a feature is documented elsewhere and pointed to to as in the official docs, a note could be made in the outlinehttp://open-ils.org/dokuwiki/doku.php?id=evergreen-docs_2.2:outline  to indicate that the specific chapter/section is ready and needed to be added to documentation ( perhaps using flashing red text  indicating "promised in release notes" so we can raise the priority ;-) )? Or if specific details about which specific feature is documented can be indicated in the DIG list communications in separate messages so we can ensure that the specific sections are included in the docs especially when promised in the release notes. The other option would be for coordination with Content Coordinators listed herehttp://open-ils.org
> /dokuwiki/doku.php?id=evergreen-docs:digparticipants  to ensure that they are aware of this existing content and provide the necessary communication to ensure it makes it into the docs and that it will be merged within
>    the context other sections of chapters in their parts. Some of the feature documentation might be parts of larger documents currently being authored so content coordination might be a good thing.
>
>
>
>
>
>
>
>


--
Sally Fortin
Director of Education
Equinox Software Inc. / Your Library's Guide to Open Source
Tel:    770-709-5572
Email:sfortin at esilibrary.com
Fax:    1-866-497-6390

_______________________________________________
OPEN-ILS-DOCUMENTATION mailing list
OPEN-ILS-DOCUMENTATION at list.georgialibraries.org
http://list.georgialibraries.org/mailman/listinfo/open-ils-documentation

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.