evergreen-docs:reorg_2014:requirements
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
evergreen-docs:reorg_2014:requirements [2016/01/21 14:16] – adding comment from 2016-01-20 DIG meeting sandbergja | evergreen-docs:reorg_2014:requirements [2016/02/04 14:13] – [Requirements] adding horizontal rule sandbergja | ||
---|---|---|---|
Line 1: | Line 1: | ||
====Introduction==== | ====Introduction==== | ||
- | ===Scope=== | + | This document describes a proposed project to re-organize the official documentation of Evergreen. |
- | ===Goals of this project=== | + | ===Methodology=== |
- | The following goals have been expressed | + | I compiled a list of mentions |
+ | |||
+ | I then created at least one concrete requirement based on each goal. | ||
+ | |||
+ | ===Conventions for this document=== | ||
+ | |||
+ | * A datetime in parentheses -- e.g. (2015-02-19 13:10:04) -- refers to a specific comment made at that time EST on the [[irc:// | ||
+ | |||
+ | |||
+ | ====Ideas expressed about this project==== | ||
+ | ===Values=== | ||
* Documentation should be written for a " | * Documentation should be written for a " | ||
+ | * This project should not interfere with DIG's ability to "keep up with docuemnting new features" | ||
+ | |||
+ | |||
+ | ===Goals=== | ||
* We would like to meet libraries' | * We would like to meet libraries' | ||
* 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) | * 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 " | ||
- | * 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" | * Books that could be printed and used as "desk copies" | ||
- | * This books shouldn' | + | * These books shouldn' |
* We would like an " | * We would like an " | ||
* Books should be presented separately, "but provide cross-search ability" | * Books should be presented separately, "but provide cross-search ability" | ||
- | * This project should leverage pre-existing open source solutions (2015-02-19 13:24:03), perhaps using some " | ||
* A procedure to "test the docs with our expected end users" (2015-02-19 13:31:17) | * A procedure to "test the docs with our expected end users" (2015-02-19 13:31:17) | ||
* A plan to " | * A plan to " | ||
- | | + | |
- | * This project should | + | |
+ | |||
+ | |||
+ | ===Ideas=== | ||
+ | * Separate books for " | ||
+ | * 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) | ||
+ | * This project should | ||
+ | * "if there are people | ||
* Possibility of using the Web Client Documentation to test the new organization (2016-01-20 14:32:57) | * Possibility of using the Web Client Documentation to test the new organization (2016-01-20 14:32:57) | ||
+ | * A "tag heirarchy could be implemented for each small chunk of documentation so you could remix them into the different types of organizing" | ||
+ | * "The table of contents [should] always displayed to the left side of the screen (an expandable list showing the major topics and nested sub-topics) the user might be able to navigate the different parts of the document faster." | ||
+ | * "The linearly organized information can be organized according to the knowledge level of the users." | ||
+ | * " | ||
+ | |||
+ | ---- | ||
====Requirements==== | ====Requirements==== | ||
- | ===Interface | + | ===Structure requirements=== |
+ | * The current documentation must be re-arranged into separate books, each of which must present content in its own specific order. | ||
+ | * The exact same content must be present in multiple books without needing to be updated separately (e.g. a chapter about the Evergreen community, or an introduction to the client interface) | ||
+ | * The HTML version needs to have crosslinks between related content in other books. | ||
+ | |||
+ | ===End-user interface | ||
==PDF generation== | ==PDF generation== | ||
+ | * PDFs should be generated (of both individual chapters and complete books) at the same time HTML is generated. | ||
+ | * PDFs need to be attractive and easy to read when printed. | ||
+ | |||
+ | ==Search== | ||
+ | * Users must be able to easily scope their search to just the current book or all books | ||
===Manageability and maintainability=== | ===Manageability and maintainability=== | ||
+ | * We need to have specific people assigned to re-organizing content and writing any new content that is needed. | ||
+ | * The documentation needs to be split into small chunks for easier maintainability. | ||
- | ====Timeline==== | + | ===Testing=== |
+ | * We need a separate server for the re-organized docs so that we can test our docs on end users without interrupting access to the current documentation. | ||
+ | * We need to identify a group of beta testers for each book that will test out each book in their day-to-day operations. | ||
- | ====Risks==== | + | ---- |
+ | ====Proposed timeline==== | ||
+ | * February 2016: Decide on coordinators who are passionate about each audience | ||
+ | * February 2016: Finalize the audiences | ||
+ | * March 2016: |
evergreen-docs/reorg_2014/requirements.txt · Last modified: 2022/02/10 13:34 by 127.0.0.1