[OPEN-ILS-DOCUMENTATION] Documentation Reorganization Discussion for 2.2

[Soulliere, Robert]

Hi All,

Given recent discussion about documentation release times got me to thinking if the documentation needs to be reorganized a bit. A few of my pet peeves about the current organization are.

1. Order: Currently the documentation starts at the most basic local level –  using the OPAC, and ends with “Development”. I wonder if it should be organized in a more global to local level as well as in a more chronological order from installation to end use. (I think a lot of software documentation starts with installation).

2. The generic “Core staff tasks” part is bothersome for me: Evergreen has grown out of this generic catch word for any task outside of system administration (Administrators as core staff too! ;-)) . I wonder if we should have separate parts for all the tasks based on the standard library processes. This is especially the case since many new features have been added to the staff tasks.

I created a draft of the proposed 2.2 outline at http://open-ils.org/dokuwiki/doku.php?id=evergreen-docs_2.2:outline

Note that I added “BASE” in brackets to indicate the chapters which should be produced at release time. These include Release Notes, System Requirements, Installation, Upgrading.
It can be expected and doable to ensure these basic chapters are ready to go at release time especially since much of the content will be included in asciidoc format with the code etc. Some coordination steps with developers will need to be adapted.

Let me know if there are others which should be published at release time?

Please discuss and let me know if their are better approaches.

Thanks,
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.