This is an old revision of the document!
Goals of this project
The following goals have been expressed on the #evergreen IRC channel:
Documentation should be written for a "really defined audience" (2015-02-19 13:09:06), rather than a "grand mass of documentation" (2015-02-19 13:10:04) that tries to be "too many things to too many people" (2015-02-19 13:09:37).
We would like to meet libraries' needs to have "essentially For Dummies books about each topical area" (2015-02-19 13:10:36)
Individual books for different classes of end-user, with "each book tailored to the end user at the desk rather than to an admin user" (2015-02-19 13:11:39)
A separate book for consortial admins with shell access vs. local admins working through the staff client (2015-02-19 13:13:25)
Books that could be printed and used as "desk copies" (2015-02-19 13:14:34)
This books shouldn't be so individualized that DIG's work becomes much less easy to maintain (2015-02-19 13:17:14)
We would like an "automated solution" creating see also
references that can jump between books (2015-02-19 13:19:38) and "that does not depend on a human to create the cross links for the HTML
version" (2015-02-19 13:22:42)
Books should be presented separately, "but provide cross-search ability" (2015-02-19 13:23:51)
This project should leverage pre-existing open source solutions (2015-02-19 13:24:03), perhaps using some "AsciiDoc /Docbook magic to combine or seperate the output after being written" (2015-02-19 13:24:23) or flossmanuals (2015-02-19 13:36:51)
A procedure to "test the docs with our expected end users" (2015-02-19 13:31:17)
Manageability and maintainability