wiki:PLATFORM_STANDARDS_DESIGN_R1

Version 6 (modified by boyan, 16 years ago) (diff)

--

Error: Macro BackLinksMenu(None) failed
compressed data is corrupt

Error: Macro 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|) failed
current transaction is aborted, commands ignored until end of transaction block

Analysis

Overview

For this revision the PLATFORM_STANDARDS_DESIGN should define rules for reviewing design phase of tasks.

Task requirements

  • For each task type define rules for the design:
    • Required section - things that are obligatory for the design in order to pass the review
    • Recommended section - things that are recommended for the design, needed for higher score
    • Optional section - things that can be included in the design and may be rated with higher score.

These rules should be stuctured like a checklist. See implementation idea for more detailed information. These requirements will be updated each week when suggestions are made.

  • Add a requirement that the reviewer should either stick to these rules or comment them in the comment section.
  • Explain when requesting a superreview is allowed.
  • Review and update the existing requirements if needed. (see if there are any comments of the document or suggest improvements.

Task result

PLATFORM_STANDARDS_DESIGN with requirements for the reviews.

Implementation idea

Change 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.

PLATFORM_STANDARDS_ANALYSIS
PLATFORM_STANDARDS_CODE
UNPLANNED_PLATFORM_STANDARDS_GENERAL_R0

How to demo

Show refactored PLATFORM_STANDARDS_DESIGN

Design

The PLATFORM_STANDARDS_DESIGN page will be restructured as follows: 

|_How to write design
|__General information
|__Task kinds
|___Coding task
|____Coding task subkinds
|___Bug fix
|___Document
|___Setup
|___Maintenance
|__Examples
|__Coding tasks approach
|___UML Diagrams
|___Unit tests
|__Reviewing
|___Scores
|___Super review
|_Comments

These sections will contain:

  • General information - a brief description of what the design should contain (applying to all task kinds).
  • Task types - for each task type there will be a list of what is required, recommended or optional.
  • Examples - several examples of good and bad designs with brief explanations of their pro and cons.
  • Coding tasks approach - a list of useful tools and brief instructions for their usage - how to make good UML diagrams, how to quickly write good unit tests.
    • This is a separate section because most of the tasks are coding tasks and their designs are quite difficult and really important.
  • Reviewing - rules for reviewing, scoring and requesting a super review - when a task should fail and when not.
  • Comments - everyone that has some opinion on the standards should describe it here.

Everyone has been asked to give his opinion in the Comments section. During the implementation these comments will be considered and integrated into the wiki page. The existing requirements will be reviewed and new will be added where necessary.

Implementation

(Implementation results should be described and linked here (from the wiki or the repository))

Testing

Comments

(Write comments for this or later revisions here.)