Changes between Version 9 and Version 10 of UNPLANNED_USER_DOC_STRUCTURE_R0

Timestamp:

12/02/08 23:49:42 (17 years ago)

Author:

dan visel

Comment:

--

UNPLANNED_USER_DOC_STRUCTURE_R0

@@ -12 +12 @@
 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. 
 
-As Sophie Reader and Sophie Server begin to exist as separate applications, each will get their own separate documenation.
+As Sophie Reader and Sophie Server begin to exist as separate applications, each will get their own separate documentation so that users can learn about each separately if they want to.
 
 == Task requirements ==
 
-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. 
+ * 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 logical page-naming structure if this is to work as a wiki; this should be extensible.
 
-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.
+ * 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 ==
 
-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).
+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). From this we can start work on real documentation. 
 
 == Implementation idea ==
 
-For an outline, see here: 
-For a style guide, see here:
+For an outline, see here: [wiki:UNPLANNED_USER_DOC_STRUCTURE_Outline]
+For a style guide, see here: [wiki:UNPLANNED_USER_DOC_STRUCTURE_StyleGuide]
 
 == Related ==
-[wiki:UNPLANNED_USER_DOC_SAMPLE_R0]
+[wiki:UNPLANNED_USER_DOC_SAMPLE_R0] (sample of user documentation)
 
 == How to demo ==
 
-Does this make sense?
+Look at the outline and style guide.
 
 = Design =