[[BackLinksMenu]]

[[TicketQuery(summary=UNPLANNED_DEVELOPMENT_OVERVIEW, compact)]]

= Analysis =

== Overview ==
The goal of this task is to collect all the necessary information for new contributors to the project in a single wiki page.

== Task requirements ==
Review all the introductory wiki pages and correct the mistakes.
Write a new wiki page, linking to the old ones
 * Each link should be preceeded by an introductory paragraph.
 * The new wiki should provide all that new members of the team need in order to get started.
 * Internal information should not be widely accessible.

== Task result ==
The result of this task is a wiki page.

== Implementation idea ==
Follow the step-by-step instructions on the introductory wiki pages (listed in the related section) and correct any mistakes or ambiguity you encounter.

== Related ==
[wiki:PLATFORM_INFRASTRUCTURE_OVERVIEW][[BR]]
[wiki:PLATFORM_DEPLOYMENT_BUILD_ECLIPSE][[BR]]
[wiki:PROCESS][[BR]]
[wiki:REPORTS][[BR]]
[wiki:PLATFORM_STANDARDS_ANALYSIS_R0]

== How to demo ==
Show the new wiki page to the team.

= Design =
'''1)''' Correct the mistakes in the wiki pages listed in the Related section. [[BR]]
'''2)''' Get rid of internal infromation that is publicly accessible. [[BR]]
'''3)''' Create a new page [wiki:DEVELOPMENT_OVERVIEW] containing:
 * Getting Started paragraph, listing the technologies used in the development process: SVN, Maven, Eclipse, Trac, JDK
 * Setup paragraph, containing step-by-step information about how to load Sophie2. Sub-paragraphs:
  * '''SVN''';
  * '''Repository''': installation, structure;
  * '''Maven''';
  * '''Eclipse''': installation, compiler settings, subclipse instalation, maven plugin instalation, importing Sophie, running Sophie
 * Tasks paragraph. Two sub-paragraphs: '''Process''', describing its importance, as well as a link to the Proccess page; '''Performing tasks''', which must include links to how to write analysis, task tips, writing reports, coding(Code Tasks Requirements, coding conventions, code smells,writing javadoc, logging) and testing(manual/auto tests).
 * Sophie2 paragraph:
  * Overview. Link to the planned Sophie intro.
  * Aspects of Sophie. 
   * Modularity, describing the idea of modules, as well as a link to the "writing modules" tutorial. Extensions and extension points, too.
   * Structure, linking to PLATFORM_STRUCTURE. Some explanations may be useful.
   * Properties, linking to the properties tutorial
   * MVC, and a link to the MVC tutorial
  * Development Issues. Must include descriptions of the main task categories, e.g. Sophie Platform(Platform Design, Plugin Architecture, Core, Base, Features), Sophie Server, Sophie end product, Project Community, Supporting Artifacts. [[BR]]
 * Getting help paragraph, with explanation how to ask if a problem comes out (for example, link to the forums).
 * Useful links. This document is located in "important docs".
''' Most of these documents are already written. According to the analysis, every paragraph must have a link to the corresponding wiki document (if it exists).'''
 * Comments section so that everyone can suggest improvements.

= Implementation =
 * Removed internal information about working hours from the [wiki:PROCESS] page.
 * Changed the [wiki:PLATFORM_INFRASTRUCTURE_OVERVIEW] page in accordance with the newly created wiki page.
 * Corrected some mistakes in the [wiki:PLATFORM_DEPLOYMENT_BUILD_ECLIPSE] page.
 * The new wiki page: [wiki:DEVELOPMENT_OVERVIEW].

= Testing =

= Comments =