Tasks results

Each task should have a wiki page which should contain one or more of the following result types:

Result Types

• Specification (produced in the analysis phase of each task) or link to specification in following format:

!== Specification ==
[wiki:PAGE]

• a link to development document (produced in the design phase). Can also be the final result of a task. This should be in following format:

!== Development Document == [source:/path/filename] ^{path here should be changed when format of development documents is chosen}

• Source code (produced in the implement phase of most tasks). Files should be linked by [source:/path/filename] in the following section:

!== Source code ==

• Diagrams (one or more, usually as a part of a specification or development document). These should be inserted in section Diagrams

!== Diagrams ==

• Diagrams should be stored in the repository, at their proper place.
  • trunk\sophie2-platform\doc\spec-diagrams
  • trunk\sophie2-platform\doc\dev-doc-diagrams
• Each diagram should be exported to PNG format with the same name as it's original format. Original format should be kept so the diagram can be edited later.
• Diagrams should be included in the wiki page by inserting
  • [[Image(source:/trunk/sophie2-platform/doc/spec-diagrams/image.png)]] for specification diagrams
  • [[Image(source:/trunk/sophie2-platform/doc/dev-doc-diagrams/image.png)]] for dev-doc diagrams.

• Maintenance
  • Maintenance/Backup results should contain description of procedures followed, date and time of maintenance and link to supporting files/scripts if any.

Example:

Specification

This section may contain specification text.
This section may contain link to [wiki:PAGE]

• Comments

Development document

path/filename1
path/filename1

• Comments

Source code

path/filename

• Comments

Diagrams

• Comments

Maintenance/Backup

• Milestone 1
  • DD-MM-YY
  • Step 1
  • Step 2
  • ...
  • path/filename1
  • path/backupscript
  • Notes
• Milestone 3
• ...
• Comments

Example source

== Specification ==
 This section may contain specification text.[[BR]]
 This section may contain link to ![wiki:PAGE]
 * Comments
== Development document ==
 [source:/path/filename1][[BR]]
 [source:/path/filename1][[BR]]
 * Comments
== Source code == 
 [source:/path/filename][[BR]]
 * Comments
== Diagrams ==
 [[Image(source:/trunk/sophie2-platform/doc/spec-diagrams/AboutDialog.png , 25%)]][[BR]]
 [[Image(source:/trunk/sophie2-platform/doc/spec-diagrams/AboutDialog.png , 25%)]][[BR]]
 * Comments
== Maintenance/Backup ==
 * Milestone 1
  * DD-MM-YY
  * Step 1 
  * Step 2
  * ...
  * [source:/path/filename1]
  * [source:/path/backupscript]
  * Notes
 * Milestone 3
 * ...
 * Comments