Changes between Version 32 and Version 33 of PLATFORM_STANDARDS_ANALYSIS

Timestamp:

01/22/09 18:12:51 (16 years ago)

Author:

boyan

Comment:

--

PLATFORM_STANDARDS_ANALYSIS

@@ -11 +11 @@
 The analysis of a task is written in a section of its wiki page called Analysis. When creating the task's page, use the TaskPageTemplate - it provides a backbone structure for the analysis, which consists of the following sections:
  * Overview - a brief description of the task (not more than a couple of sentences). In the first revision of the task, it should provide a brief overview of the whole task as well as what should be done in this revision. Otherwise, it should state what the current revision of the task is about. 
- * Task requirements - probably the most important section. It should include a list of requirements that the task must fulfill. These are used for reviewing the design and implementation phase so they should be chosen very carefully. It is recommended to write them as a bullet list. Make sure the requirements are fulfillable for the effort of the current revison of the task. When not sure, mark the less important requirements as oprional.
+ * Task requirements - probably the most important section. It should include a list of requirements that the task must fulfill. These are used for reviewing the design and implementation phase so they should be chosen very carefully. It is recommended to write them as a bullet list. Make sure the requirements are fulfillable for the effort of the current revison of the task. When not sure, mark the less important requirements as optional.
  * Task result - a short phrase or sentence of what the task result should be (for example "Source code"). If the results are more than one, it is recommended to list them as bullets.
  * Implementation idea - a brief description of how you would approach the task if you were to implement it. If you don't have a clear implementation idea, then you shouldn't write the analysis of this task.
@@ -90 +90 @@
 
 == Examples ==
+Please note that these examples have been created according to the previous version of the standards and do not fully reflect the new ones.
+
+[wiki:BASE_HALOS_R0] - clear, concise and easily readable.[[BR]]
+[wiki:AUDIO_CONTENT_R0] - although a bit long, the overview gives a clear idea about what the task is about.[[BR]]
+[wiki:S2S_TESTING_SERVER_R0] - clear and well structured.
 
 == Reviewing ==
@@ -95 +100 @@
 The reviewer should track the presence of the following things:
  * Required things:
-  * Information in all sections of the analysis according to the descriptions mentioned above.
+  * Information in all sections of the analysis according to the descriptions mentioned above (both the general ones and those regarding the specific kind of task).
   * Clarity of expression - no misleading things that can be misunderstood or misinterpreted.
  * Recommended things: