evergreen-docs:reorg_2014:requirements
Differences
This shows you the differences between two versions of the page.
Next revision | Previous revisionNext revisionBoth sides next revision | ||
evergreen-docs:reorg_2014:requirements [2016/01/21 10:37] – created sandbergja | evergreen-docs:reorg_2014:requirements [2016/02/09 11:47] – [Introduction] changing doc conventions sandbergja | ||
---|---|---|---|
Line 1: | Line 1: | ||
====Introduction==== | ====Introduction==== | ||
- | =====Scope===== | + | This document describes a proposed project to re-organize the official documentation of Evergreen. |
+ | ===Methodology=== | ||
+ | I compiled a list of mentions of this project by searching in IRC and mailing list logs. I then categorized these into values, goals, and ideas on this wiki page. | ||
+ | |||
+ | I then created at least one concrete requirement based on each goal. | ||
+ | |||
+ | ===Conventions for this document=== | ||
+ | |||
+ | * Links in the Values, Goals, and Ideas sections refer to specific comments made on the [[irc:// | ||
+ | |||
+ | |||
+ | ====Ideas expressed about this project==== | ||
+ | ===Values=== | ||
+ | * Documentation should be written for a [[http:// | ||
+ | * This project should not interfere with DIG's ability to [[http:// | ||
+ | |||
+ | |||
+ | ===Goals=== | ||
+ | * We would like to meet libraries' | ||
+ | * Individual books for different classes of end-user, with [[http:// | ||
+ | * [[http:// | ||
+ | * [[http:// | ||
+ | * We would like an [[http:// | ||
+ | * [[http:// | ||
+ | * [[http:// | ||
+ | * [[http:// | ||
+ | * [[http:// | ||
+ | |||
+ | |||
+ | |||
+ | ===Ideas=== | ||
+ | * Separate books for [[http:// | ||
+ | * [[http:// | ||
+ | * [[http:// | ||
+ | * This project should leverage pre-existing open source solutions), perhaps using some [[http:// | ||
+ | * [[http:// | ||
+ | * Possibility of using the [[http:// | ||
+ | * [[http:// | ||
+ | * [[http:// | ||
+ | * [[http:// | ||
+ | * [[http:// | ||
+ | |||
+ | |||
+ | |||
+ | ---- | ||
====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== | ||
+ | * 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=== | ||
+ | * 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. | ||
- | ====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