Arca - Estrutura

A estrutura esperada para monografia eh:

  1. definicao do sistema principal da arca
  2. estimativa inicial de prazos e do andamento do projeto
  3. metricas post-mortem do andamento do projeto
  4. bibliografia utilizada
  5. ferramentas e tecnicas utilizadas
  6. tecnicas relevantes para o problema em questao, mas que nao tenham sido exploradas por falta de tempo ou recursos humanos
  7. Consideracoes subjetivas sobre o curso e seu aproveitamento

Directory Layout

The layout of Arca's source tree is in conformance to Maven Directory Layout.

Documentation

Toda documentacao da Arca, incluindo a monografia sera escrita em Extensible Markup Language (XML) 1.0 (Second Edition) W3C Recommendation of 6 October 2000.

O XML serah processado e transformado em HTML 4.01 Specification W3C Recommendation of 24 December 1999.

The navigability of the documentation is based on menus residing on the left of every web page. Some of the menu items will be expandible menus meaning that when they are clicked, one or more sub menus apear enabling a more detailed navigation into that section.

An example of the result of this process is this document itself. This document is the resulting HTML output of the processing of estrutura.xml XML document.

In addition, different types of information about the project will be provided under the Project Documentation menu. For a better understandig of what's provided there simply navigate the menus.

Source Code

Most of the source code will be written according to The JavaTM Language Specification, Second Edition. All java code will be in confomance to the "Code Conventions for the Java Programming Language" as published by Sun.

Arca is a project of the Arca Group and therefore will respect the standards of package naming. This means that the packages will be named starting with br.usp.ime.arca.arca.

All java source code will be provided in several ways

  • Source distribution files
    For more information of the distrubution files check the documentation on Releases.
  • CVS Repository
    A link to the Source Repository is provided on the Project Info sub menu.
  • Source Xreference
    The source cross reference of all java source can be navigated via the Source XReference link under the Project Documentation menu.
  • API documentation
    The generated API documentation can be navigated by clicking on the JavaDocs link under the Project Documentation menu.

Unit Testing

The integrity of Arca will be backed up by Unit Tests. This will be acomplished by using the JUnit framework.

Test results will also be avaliable on the site under the Unit Tests sub menu of the Project Reports menu under Project Documentation.