Changes between Version 1 and Version 2 of UNPLANNED_USER_DOC_STRUCTURE_R0


Ignore:
Timestamp:
12/02/08 20:27:30 (16 years ago)
Author:
dan visel
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • UNPLANNED_USER_DOC_STRUCTURE_R0

    v1 v2  
    55 
    66= Analysis = 
    7 ^(The purpose of the analysis is to give as much as possible of the needed information for designing and implementing the task.)^ 
     7 
     8This is the structure for user documentation on the Sophie 2 website. 
    89 
    910== Overview == 
    10 ^(The analysis of the first revision of each task should contain a brief overview of the whole task. Stick to the current revision of the task, but keep an eye to the whole task progress, and stay alert for possible smells.)^ 
     11 
     12User 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.  
    1113 
    1214== Task requirements == 
    13 ^(Necessary requirements that the task must fulfill.)^ 
     15 
     16The 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.  
    1417 
    1518== Task result ==