Changes between Version 2 and Version 3 of UNPLANNED_USER_DOC_STRUCTURE_R0

Timestamp:

12/02/08 20:31:30 (16 years ago)

Author:

dan visel

Comment:

--

UNPLANNED_USER_DOC_STRUCTURE_R0

@@ -10 +10 @@
 == Overview ==
 
-User documentation will be online in the Trac wiki until the final release. To start it will follow the outline for the Sophie 1.0 documentation (online here: http://asteasolutions.net:7080/sophie2/ticket/1590 ). Major sections will each get a page. 
+User documentation will be online in the Trac wiki until the final release. To start it will follow the outline for the Sophie 1.0 documentation (online here in PDF form: http://sophieproject.cntv.usc.edu/files/SophieHelp1.0.3.pdf ). Major sections (e.g. 2. Working with Sophie, 3. Working with Frames) will each get a page with an introduction and a table of contents. Subsections in each section (e.g. 2.1. Sophie's Interface, 2.2. Halos & Huds) will each get their own page. 
 
 == Task requirements ==
 
 The user documentation will eventually need to provide information for users of Sophie Author, Sophie Reader, and Sophie Server. As Sophie Reader and Sophie Server become more defined, they will get their own sections; these received little attention in the Sophie 1.0 documentation. 
+
+There needs to be a logical page-naming structure; this should be extensible.
+
+There needs to be a (possibly rudimentary) style guide covering how images are handled, how numbering is handled, similar issues.
 
 == Task result ==