| 1 | | = Tasks results = |
| 2 | | Each task should have a wiki page which should contain one or more of the following result types: |
| 3 | | == Result Types == |
| 4 | | * Specification (produced in the analysis phase of each task) or link to specification in following format: |
| 5 | | !== Specification ==[[BR]] |
| 6 | | ![wiki:PAGE] |
| 7 | | * 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: |
| 8 | | !== Development Document == |
| 9 | | ![source:/path/filename] ^path here should be changed when format of development documents is chosen^ |
| 10 | | * Source code (produced in the implement phase of most tasks). Files should be linked by ![source:/path/filename] in the following section: |
| 11 | | !== Source code == |
| 12 | | * Diagrams (one or more, usually as a part of a specification or development document). These should be inserted in section Diagrams |
| 13 | | !== Diagrams == |
| 14 | | * Diagrams should be stored in the repository, at their proper place. |
| 15 | | * trunk\sophie2-platform\doc\spec-diagrams |
| 16 | | * trunk\sophie2-platform\doc\dev-doc-diagrams |
| 17 | | * 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. |
| 18 | | * Diagrams should be included in the wiki page by inserting |
| 19 | | * ![[Image(source:/trunk/sophie2-platform/doc/spec-diagrams/image.png)]] for specification diagrams |
| 20 | | * ![[Image(source:/trunk/sophie2-platform/doc/dev-doc-diagrams/image.png)]] for dev-doc diagrams. |
| 21 | | * Maintenance |
| 22 | | !== Maintenance == |
| 23 | | * Maintenance/Backup results should contain description of procedures followed, date and time of maintenance and link to supporting files/scripts if any. |
| 24 | | |
| 25 | | = Example: = |
| 26 | | == Specification == |
| 27 | | This section may contain specification text.[[BR]] |
| 28 | | This section may contain link to [wiki:PAGE] |
| 29 | | * Comments |
| 30 | | == Development document == |
| 31 | | [source:/path/filename1][[BR]] |
| 32 | | [source:/path/filename1][[BR]] |
| 33 | | * Comments |
| 34 | | == Source code == |
| 35 | | [source:/path/filename][[BR]] |
| 36 | | * Comments |
| 37 | | == Diagrams == |
| 38 | | [[Image(source:/trunk/sophie2-platform/doc/spec-diagrams/AboutDialog.png)]] |
| 39 | | [[Image(source:/trunk/sophie2-platform/doc/spec-diagrams/AboutDialog.png)]][[BR]] |
| 40 | | * Comments |
| 41 | | == Maintenance/Backup == |
| 42 | | * Milestone 1 |
| 43 | | * DD-MM-YY |
| 44 | | * Step 1 |
| 45 | | * Step 2 |
| 46 | | * ... |
| 47 | | * [source:/path/filename1] |
| 48 | | * [source:/path/backupscript] |
| 49 | | * Notes |
| 50 | | * Milestone 3 |
| 51 | | * ... |
| 52 | | * Comments |
| 53 | | = Example source = |
| 54 | | {{{ |
| 55 | | == Specification == |
| 56 | | This section may contain specification text.[[BR]] |
| 57 | | This section may contain link to [wiki:PAGE] |
| 58 | | * Comments |
| 59 | | == Development document == |
| 60 | | [source:/path/filename1][[BR]] |
| 61 | | [source:/path/filename1][[BR]] |
| 62 | | * Comments |
| 63 | | == Source code == |
| 64 | | [source:/path/filename][[BR]] |
| 65 | | * Comments |
| 66 | | == Diagrams == |
| 67 | | [[Image(source:/trunk/sophie2-platform/doc/spec-diagrams/AboutDialog.png , 25%)]][[BR]] |
| 68 | | [[Image(source:/trunk/sophie2-platform/doc/spec-diagrams/AboutDialog.png , 25%)]][[BR]] |
| 69 | | * Comments |
| 70 | | == Maintenance/Backup == |
| 71 | | * Milestone 1 |
| 72 | | * DD-MM-YY |
| 73 | | * Step 1 |
| 74 | | * Step 2 |
| 75 | | * ... |
| 76 | | * [source:/path/filename1] |
| 77 | | * [source:/path/backupscript] |
| 78 | | * Notes |
| 79 | | * Milestone 3 |
| 80 | | * ... |
| 81 | | * Comments |
| 82 | | }}} |
| | 1 | = Tasks results types = |
| | 2 | The results of this phase should be described in the Implementation section of the task's current revision page. Depending on task type, results can be |
| | 3 | * Wiki Page |
| | 4 | * Source code |
| | 5 | * Other document in the repository. |
| | 6 | |
