[[BackLinksMenu]]

![[TicketQuery(summary=TASK_NAME_R?, compact)]]


= Analysis =

This is the structure for user documentation on the Sophie 2 website.

== 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 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.

== 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. 

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. 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).

== Implementation idea ==

For an outline, see here: 
For a style guide, see here:

== Related ==

[[http://asteasolutions.net:7080/sophie2/ticket/1590]]

== How to demo ==

Does this make sense?

= Design =

= Implementation =
^(Implementation results should be described and linked here (from the wiki or the repository))^

= Testing =

= Comments =
^(Write comments for this or later revisions here.)