Error: Macro BackLinksMenu(None) failed

compressed data is corrupt

Tasks types

Currently we have five task types. Each task has different requirements for revision phases - Analysis, Design and Implementation.

• Coding tasks
  • Description - This task type contains tasks which result should be added application functionality, code change/improvement.
  • Analysis - Analysis of these tasks revision contains what are the requirements for the task, what are expected results, functionality/improvement requirements, how-to demos, implementation ideas.
  • Design - Design of these tasks should describe technology that will be used for reaching task's requirement. It should contain initial tests, libraries needed, rough algorithm explanation, class diagrams, etc.
  • Implementation - In the implementation section of the task's revision there should be a link to the change set of the commit where the modifications are done. Explanation of the changes should be provided. Write down the added functionalities or improvements that the tasks code bring to the project. Explain which part of source you've added/edited and how. The result of your work should be presentable in Analysis/How to Demo section.
  • Testing - In testing should be described how this task will be tested, here should be linked trac tickets, auto tests, test cases.
  • Coding task kinds
    • external feature (visible from the user):
      • analyzing
        • should have a specification, and a manual testing scenario
      • designing
        • write an automatic test or tests that verifies that your feature is working
        • look at the related code
        • decide what needs to be added
        • if you add new library feature
          • write use case tests for it
        • you may also write skeleton types (only declaration) and demos
          • write an outline of your design.
      • implementing
        • make all the designed things work.
        • ensure that all tests pass.
        • during the process, add more tests.
    • Researching about a technology or library
      • analyzing: specify what needs to be researched
        • what the research will solve
        • what is needed to be solved (this is important)
      • designing
        • you can try things, but do not pollute the main source (for example with libraries)
        • if you need to use other libraries, do it in another project (or in another branch)
        • if you don't need other libraries, you can do it in a research package, but you should make sure that you don't introduce warnings, failing tests, etc.
      • implementing
        • you present the written results / conclusions of your research, demo codes, etc.
      • reviewers: 1-2 developers
    • implementing a new internal feature (a library or something, not directly visible)
      • analyzing: what the library will provide
      • designing: should include:
        • use case tests
        • samples
        • demo (in some cases),
        • design outline
      • implementing
        • the library should be implemented
        • enough tests should be written during the process
        • reviewers: 2 developers
    • Performing structure changes or refactoring.
      • analyzing: what the issues are
      • designing: understanding it, and providing an idea how to fix the issues
      • implementing: fixing the issues
      • reviewers: 1-2 developers
  • Examples: BASE_BOUND_CONTROLS_R0; PRO_LIB_CORE_TUTORIAL_R0

• Bug Fix
  • Description - Bug fix type tasks are part of Unplanned tasks. These tasks consist of different kinds of unwanted application behavior - lack of functionality, wrong functionality, different errors. Bug tasks should be presented as "BUG_TASK_NAME"
  • Analysis - Analysis of Bug Fixes should contain exact explanation of exactly happens / not happens (what's wrong). How to demo should contain steps to recreate to prove that the bug doesn't exist anymore. In this section links to tickets can be very useful
  • Design - Design of bug fixes is similar to Coding tasks' design, but should also answer the questions why does this bug appear, which part of the code is guilty for the wrong functionality (what was wrong with the code, why it was not suitable). Design also contains auto-tests that prove bug wouldn't be presented after implementation.
  • Implementation - Implementation section should contain link to files where was added/maintained/re factored code, should also describe what was done. The implementation also must contain information about the problems causing the bug and how were they bypassed. The results should be presentable in Analysis/How to Demo section.
  • Testing - In testing should be described how bug task will be tested, here should be linked trac tickets, auto tests, test cases.
  • Example - none for now (will be added when such is available)
• Document
  • Description - Document tasks require different documents as result. In most cases, these documents are auxiliary for other tasks. Commonly, the result of document tasks will be Wiki page, but may also be other document and may consist of text, diagrams, media files, spreadsheets, examples, etc.
  • Analysis - Analysis section should contain document requirements (file format, dimensions, formatting), contents requirements. This section should also contain related tasks - tasks that depend on that one, tasks of which this task depends, similar tasks, etc.
  • Design - Design should point which tools will be used, how the document will be created.
  • Implementation - Implementation section as in other tasks should contain link to created documents and explanation how they were done. Because most of the tasks include more than one revision you must explain what's added/improved during the last revision. The results should be presentable in Analysis/How to Demo section.
  • Example - PROCESS
• Setup
  • Description - The result of this tasks are hardware/software setup of different computer appliances that will be used for executing all other tasks. These contain website, wiki, developer platform setup, etc.
  • Analysis - Analysis answers the question what are the requirements for this appliance - hardware and software. For example, some of the community server hardware requirements are space and bandwidth, and software - running web server, security issues. Here should be also listed tasks that depend on that one. How to demo should point the address of the server/computer and presentation of some features.
  • Design - In this 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.
  • Implementation - This section should contain how exactly was this appliance set up. Write down a step by step manual of the setup states Give links to any setup files (scripts) or other information in order for the server to be recreated.
  • Example - SCS_MACHINE_SETUP_R0
• Maintenance (Managing)
  • Description - These tasks' aim is to keep servers, important documents, code in perfect working condition. These tasks' revisions are regularly on the schedule.
  • Analysis - Analysis should cover current issues of the server/document/code, suggestions for improving. Analysis should also contain list of trivial actions that have to be done every maintenance revision.
  • Design - 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.
  • Implementation - Implementation consist of trivial actions done every maintenance and improvements listed in the design. Implementation steps should be described. For the maintenance of documents should be provide link.
  • Example - INTERNAL_BACKLOG_MAINTENANCE_R0

Results

The results of tasks' revisions should be described in the Implementation section of the task's current revision page PageTemplates/TaskPageTemplate. Depending on task type, results can be

• Wiki Pages
• Source code
• Design section of the same task.
• Other documents in the repository.
• Other links.

These should be linked into the Implementation section. If needed, additional wiki pages should be created and linked as TASK_NAME/PART where PART should describe the containing of this wiki page. In different revisions same results can be linked, but revision result should be described.

Naming conventions for wiki pages

We need to specify the naming convention for the wiki pages explicitly.

• Pages for tasks are written in UPPER_CASE (as the task id). Like "PLATFORM_NFR_USABILITY_R0".
• If the result of the task is a wiki page, nice candidate for this page is the task name (without the revision). E.g. "PLATFORM_NFR_USABILITY".
• If the result of the task consists of several wiki page, then the "/" convention for trac sub-pages can be used. E.g. "PLATFORM_NFR_USABILITY/Commons", "PLATFORM_NFR_USABILITY/SuperSpecific", etc.
• When a page, is not directly related to a task (like the Commons in this example) it is named in the usual (CamelCase).
• In rare cases, we may create pages, that do not relate to a specific schedule item. They should be also named in CamelCase, but creation of such pages should be discussed with the leader.

Comments

• It should become clear what is a requirement for passing a given stage, what is recommended, and what is optional. This should be synchronized with the Analysis and Design pages. When giving examples they either should be very good or a list of suggested improvements should be provided. --boyan@2009-01-12
• It might be useful to have a guide for reviewers on what the various grades mean - when a task deserves a 3, when a 4, when a 5. Does that go here or somewhere else? --danvisel@2009-01-15
• The testing description is not correct. You may have a look at the release team working process for some more info on that (although it still needs more clarifications). --pap@2009-01-15