Changes between Version 3 and Version 4 of UNPLANNED_USER_DOC_STRUCTURE_R0

Timestamp:

12/02/08 20:34:58 (16 years ago)

Author:

dan visel

Comment:

--

UNPLANNED_USER_DOC_STRUCTURE_R0

@@ -14 +14 @@
 == 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. 
+The user documentation will eventually need to provide information for users of Sophie Author, Sophie Reader, and Sophie Server; eventually, these need to become three separate documents (although interconnected). For now, I'm going to start with a single document for Sophie with the idea that this is going to be split into sections. 
 
 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.
+There needs to be a (possibly rudimentary) style guide covering how images are handled, how numbering is handled, similar issues. Style guide isn't exposed to the public.
 
 == Task result ==
-^(The Analysis should contain strict requirements about the end product of the task (for example the result must be source code, the result must be google doc, etc.))^
+
+For this task, there will be a sample outline (as a page in the wiki) and a sample style guide (as a page in the wiki).
 
 == Implementation idea ==
-^(It is advisable to include some rough implementations ideas.)^
+
+For an outline, see here: 
+For a style guide, see here:
 
 == Related ==
-^(Here you can add related tasks that could be useful or helpful.)^
+
+The style guide is related.
 
 == How to demo ==
-^(In this section you must add instructions for the demo of the task.)^
+
+Does this make sense?
 
 = Design =