Version 3 (modified by dan visel, 16 years ago) (diff) |
---|
[[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.
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
(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.))
Implementation idea
(It is advisable to include some rough implementations ideas.)
Related
(Here you can add related tasks that could be useful or helpful.)
How to demo
(In this section you must add instructions for the demo of the task.)
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.)