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:[email protected]
Fax: 1-866-497-6390
_______________________________________________
OPEN-ILS-DOCUMENTATION mailing list
[email protected]
http://list.georgialibraries.org/mailman/listinfo/open-ils-documentation
