evergreen-docs:reorg_2014:requirements
This is an old revision of the document!
Table of Contents
Introduction
Scope
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)
- Separate books for "cataloging, circulation, acquisitions" (2016-01-20 14:54:19)
- A separate book for consortial admins with shell access vs. local admins working through the staff client (2015-02-19 13:13:25)
- Possibly a separate book for patrons (2016-01-20 14:56:11)
- 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)
- A plan to "convert that excitement into some actual commitment to assist with the (huge) project" (2016-01-20 14:17:25)
- "if there are people with specific interests, they can be the initial compilers of the area documentation" (2016-01-20 14:21:33)
- This project should not interfere with DIG's ability to "keep up with docuemnting new features" (2016-01-20 14:26:51)
- Possibility of using the Web Client Documentation to test the new organization (2016-01-20 14:32:57)
Requirements
Interface requirements
PDF generation
Manageability and maintainability
Timeline
Risks
evergreen-docs/reorg_2014/requirements.1453403785.txt.gz · Last modified: 2022/02/10 13:34 (external edit)