Changes between Version 1 and Version 2 of PLATFORM_STANDARDS_DESIGN_R1


Ignore:
Timestamp:
12/20/08 14:13:40 (16 years ago)
Author:
deyan
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • PLATFORM_STANDARDS_DESIGN_R1

    v1 v2  
    11[[BackLinksMenu]] 
    22 
    3 [[TicketQuery(summary=TASK_NAME_HERE, format=table, col=summary|owner|status|type|component|priority|effort|importance, rows=description|analysis_owners|analysis_reviewers|analysis_score|design_owners|design_reviewers|design_score|implementation_owners|implementation_reviewers|implementation_score|test_owners|test_reviewers|test_score|)]] 
    4  
    5  
    6  
     3[[TicketQuery(summary=PLATFORM_STANDARDS_DESIGN_R1, format=table, col=summary|owner|status|type|component|priority|effort|importance, rows=description|analysis_owners|analysis_reviewers|analysis_score|design_owners|design_reviewers|design_score|implementation_owners|implementation_reviewers|implementation_score|test_owners|test_reviewers|test_score|)]] 
    74= Analysis = 
    8 ^(The purpose of the analysis is to give as much as possible of the needed information for designing and implementing the task.)^ 
    9  
    105== Overview == 
    11 ^(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.)^ 
    12  
     6For this revision the [wiki:PLATFORM_STANDARDS_DESIGN] should define rules for reviewing design phase of tasks. 
    137== Task requirements == 
    14 ^(Necessary requirements that the task must fulfill.)^ 
    15  
     8 * For each task type define rules for the design: 
     9  * Required section - things that are obligatory for the design in order to pass the review 
     10  * Recommended section - things that are recommended for the design, needed for higher score 
     11  * Optional section - things that can be included in the design and may be rated with higher score.  
     12These rules should be stuctured like a checklist. 
     13See implementation idea for more detailed information. These requirements will be updated each week when suggestions are made.  
     14 * Add a requirement that the reviewer should either stick to these rules or comment them in the comment section. 
     15 * Explain when requesting a superreview is allowed. 
    1616== Task result == 
    17 ^(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.))^ 
    18  
     17[wiki:PLATFORM_STANDARDS_DESIGN] with requirements for the reviews.  
    1918== Implementation idea == 
    20 ^(It is advisable to include some rough implementations ideas.)^ 
    21  
     19Change the formatting for the task types. Split the requirements after each task type in subsections. Define required, recommended and optional sections. Expand the document where needed. 
    2220== Related == 
    23 ^(Here you can add related tasks that could be useful or helpful.)^ 
    24  
     21[wiki:PLATFORM_STANDARDS_ANALYSIS][[BR]] 
     22[wiki:PLATFORM_STANDARDS_CODE][[BR]] 
    2523== How to demo == 
    26 ^(In this section you must add instructions for the demo of the task.)^ 
    27  
     24Show refactored [PLATFORM_STANDARDS_DESIGN] 
    2825= Design = 
    29  
    3026= Implementation = 
    3127^(Implementation results should be described and linked here (from the wiki or the repository))^ 
    32  
    3328= Testing = 
    34  
    3529= Comments = 
    3630^(Write comments for this or later revisions here.)