wiki:PLATFORM_STANDARDS_ANALYSIS

Version 12 (modified by deyan, 16 years ago) (diff)

--

  • The purpose of the analysis is to give as much as possible of the needed information for designing and implementing the task.
  • The analysis of the first revision of each task should contain a brief overview of the whole task.
  • Think well about the task! You should figure out very well what the aim (result) of the task should be and how to be reached.
  • List the main features that have to be present in the final result of the task. These are used later to verify the design and implementation.
  • Stick to the current revision of the task, but keep an eye to the whole task progress, and stay alert for possible smells.
  • It is strongly recommended to discuss unclear aspects of the task with other team members.
  • It is advisable to include some rough implementations ideas.
  • Analyses must be kept in the task's page in chapter called Analysis.
  • Every analysis must be made by one developer and one QA, and reviewed by other developer/QA.
  • You can use PageTemplates/TaskPageTemplate#Analysis wiki page template for your analysis.
  • Example for analysis that meets the requirements is GLOBAL_SPEC_STRUCTURE_R0

Depending on task type design section should contain

  • Coding tasks - Analysis of these tasks should describe the aim of this revision.
    • Overview - contains explanation of the task. This explanation should present what will be done from the user point of view, what will be the visible result from the task.
    • Requirements - Here should be listed requirements of the result - what is desired functionality, what should this element have, etc.
    • Task result - In this section should be listed what is the result of the task. For these tasks it will be code but depending on task may also contain diagrams, graphics, etc
    • Implementation idea - Brief overview of implementation methods, suggested algorithms, etc.
    • Related - Here should be listed related tasks that might be useful for solving this task. You may also point to previous and next revisions of the same task, useful external links, etc.
    • How to demo - Explains how the result of this task may be presented to the team or external person.
  • Bug Fix - Analysis of bug fixes should explain what the problem is, in which module, when it appears.
    • Overview - explains the mis functionality in a sentence. Describe what happens and in what circumstances.
    • Requirements - Here should be listed requirements of the result - what is the expected functionality. Please give detailed requirements, the bug can be a result of misunderstanding the original task requirements.
    • Task result - In this section should be listed what is the result of the task. For these tasks it will be maintained code but depending on task may also contain diagrams, graphics, etc
    • Implementation idea - Brief overview of implementation methods, suggested algorithms, etc. You may point the mistaken part of the code here.
    • Related - Here should be listed related tasks that might be useful for solving this task. You should list tasks that depend on this bug (mis functionality, lack of feature, etc). You should also point related use cases.
    • How to demo - Depending on task requirements, explain the problem in Implementation or Design, present the solution in Implementation section. Link useful test cases.
  • Document - Analysis of documents tasks should point the aim of this document.
    • Overview - Overview of specific revision should point what will be done in this revision.
    • Requirements - Requirements to the documents that will be the result
      • What sections should they contain
      • Are these internal or external documents.
      • Optional - who has to read these documents and in what period.
      • Is it an important document.
    • Task result - Should point revision target documents - wiki pages, diagrams, etc.
    • Implementation idea - You may research related examples and share them in this section.
    • Related - Here should be listed related tasks that might be useful. You should link previous revisions of this task. You may list useful external links too.
    • How to demo - Link the document and give idea about highlighting parts of the implementation.
  • Setup -
    Design  section should be decided which computer appliance will satisfy the requirements, how it will be set up, what technologies will be used. Give links to websites of software solutions that should be used. These tasks should be designed by a developer.
      * Hardware requirements - point specific hardware requirements, limitations if any.
      * Software requirements - point which of the suitable tools will be installed and configured.  
    
  • Maintenance -
    Design explains what should be done for meeting the requirements, links to tools that will be used, algorithms, diagrams and whatever is needed for an easy implementation. Depending on specific task, these tasks may be designed by developer or qa.
      * If script are needed, design and link them
      * Link any used tools for maintaining appliances/files.
    A good design doesn't leave any questions about implementation - when it's read, implementation should be trivial. Parts of the design may be pointed as implementation.
    
    Use the design section [wiki:PageTemplates/TaskPageTemplate#Design] of the Task Page Template.