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/25 11:17] – adding more to the document, separating ideas into values, goals, and ideas sandbergja | evergreen-docs:reorg_2014:requirements [2016/02/04 14:13] – [Requirements] adding horizontal rule sandbergja | ||
|---|---|---|---|
| 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 in parentheses -- e.g. (2015-02-19 13:10:04) -- refers to a specific comment made at that time EST on the [[irc:// | + | |
| Line 47: | Line 45: | ||
| + | ---- | ||
| ====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. | ||
| + | |||
| + | ===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