evergreen-docs:reorg_2014:requirements
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
evergreen-docs:reorg_2014:requirements [2016/01/25 11:17] – adding more to the document, separating ideas into values, goals, and ideas sandbergja | evergreen-docs:reorg_2014:requirements [2016/02/10 14:29] – [Requirements] jpringle | ||
---|---|---|---|
Line 1: | Line 1: | ||
====Introduction==== | ====Introduction==== | ||
- | This document describes a proposed project to re-organize the official documentation of Evergreen. | + | This document describes a proposed project to re-organize the official documentation of Evergreen. |
- | + | ||
- | ===Scope=== | + | |
===Methodology=== | ===Methodology=== | ||
Line 11: | Line 9: | ||
===Conventions for this document=== | ===Conventions for this document=== | ||
- | * A datetime | + | |
====Ideas expressed about this project==== | ====Ideas expressed about this project==== | ||
===Values=== | ===Values=== | ||
- | * Documentation should be written for a " | + | * Documentation should be written for a [[http:// |
- | * This project should not interfere with DIG's ability to "keep up with docuemnting new features" | + | * This project should not interfere with DIG's ability to [[http:// |
===Goals=== | ===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" | + | * Individual books for different classes of end-user, with [[http:// |
- | * Books that could be printed and used as "desk copies" | + | * [[http:// |
- | * These books shouldn' | + | * [[http:// |
- | * We would like an " | + | * We would like an [[http:// |
- | * Books should be presented separately, "but provide cross-search ability" | + | * [[http:// |
- | * A procedure to "test the docs with our expected end users" | + | * [[http:// |
- | * A plan to " | + | * [[http:// |
- | * " | + | * [[http:// |
===Ideas=== | ===Ideas=== | ||
- | * Separate books for " | + | * Separate books for [[http:// |
- | * A separate book for consortial admins with shell access vs. local admins working through the staff client | + | * [[http:// |
- | * Possibly a separate book for patrons | + | * [[http:// |
- | * This project should leverage pre-existing open source solutions | + | * This project should leverage pre-existing open source solutions), perhaps using some [[http:// |
- | * "if there are people with specific interests, they can be the initial compilers of the area documentation" | + | * [[http:// |
- | * Possibility of using the Web Client Documentation to test the new organization | + | * Possibility of using the [[http:// |
- | * A "tag heirarchy could be implemented for each small chunk of documentation so you could remix them into the different types of organizing" | + | * [[http:// |
- | * "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." | + | * [[http:// |
- | * "The linearly organized information can be organized according to the knowledge level of the users." | + | * [[http:// |
- | * " | + | * [[http:// |
+ | ---- | ||
====Requirements==== | ====Requirements==== | ||
- | ===Interface | + | |
+ | [[evergreen-docs: | ||
+ | ===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. | ||
+ | |||
+ | ===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. | ||
+ | ---- | ||
====Proposed timeline==== | ====Proposed timeline==== | ||
* February 2016: Decide on coordinators who are passionate about each audience | * February 2016: Decide on coordinators who are passionate about each audience | ||
* February 2016: Finalize the audiences | * February 2016: Finalize the audiences | ||
* March 2016: | * March 2016: |
evergreen-docs/reorg_2014/requirements.txt · Last modified: 2022/02/10 13:34 by 127.0.0.1