| | 28 | |
| | 29 | The [wiki:PLATFORM_STANDARDS_DESIGN] page will be restructured as follows: |
| | 30 | {{{ |
| | 31 | |_How to write design |
| | 32 | |__General information |
| | 33 | |__Task kinds |
| | 34 | |___Coding task |
| | 35 | |____Coding task subkinds |
| | 36 | |___Bug fix |
| | 37 | |___Document |
| | 38 | |___Setup |
| | 39 | |___Maintenance |
| | 40 | |__Examples |
| | 41 | |__Coding tasks approach |
| | 42 | |___UML Diagrams |
| | 43 | |___Unit tests |
| | 44 | |__Reviewing |
| | 45 | |___Scores |
| | 46 | |___Super review |
| | 47 | |_Comments |
| | 48 | }}} |
| | 49 | |
| | 50 | These sections will contain: |
| | 51 | * General information - a brief description of what the design should contain (applying to all task kinds). |
| | 52 | * Task types - for each task type there will be a list of what is required, recommended or optional. |
| | 53 | * Examples - several examples of good and bad designs with brief explanations of their pro and cons. |
| | 54 | * 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. |
| | 55 | * This is a separate section because most of the tasks are coding tasks and their designs are quite difficult and really important. |
| | 56 | * Reviewing - rules for reviewing, scoring and requesting a super review - when a task should fail and when not. |
| | 57 | * Comments - everyone that has some opinion on the standards should describe it here. |
| | 58 | |
| | 59 | 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. |
| | 60 | |
