This is an old revision of the document!
This document describes a proposed project to re-organize the official documentation of Evergreen. It is intended to spark discussion at a meeting on February 10, 2016.
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
A datetime in parentheses – e.g. (2015-02-19 13:10:04) – refers to a specific comment made at that time EST on the #evergreen IRC channel
Ideas expressed about this project
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)
version needs to have crosslinks between related content in other books.
End-user interface requirements
Manageability and maintainability
We need to have specific people assigned to re-organizing content and writing any new content that is needed. These should preferably not be current DIG members, so that the demands of documenting new features don't interfere with the completion of this project.
The documentation needs to be split into small chunks for easier maintainability.
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.