Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Comentário: Adição da estrutura de artefatos em repositório versionado.

...

Na figura anexa,  uma ideia de como deve ser isso na pratica diaria.

Artefatos em Repositório Versionado

 Todos os artefatos armazenados em repositório versionado devem seguir um padrão de nomenclatura e de estruturação de diretórios. Essa padronização visa principalmente:

  1. Permitir a fácil navegação entre os diferentes clientes, seus projetos, áreas de domínio, artefatos e seus tipos. Por exemplo, ter facilidade para encontrar todos os documentos do Cliente X, ou todos os documentos do cliente X que dizem respeito à área técnica, ou todos os documentos da área técnica que foram enviados pelo cliente para a empresa.
  2. Permitir a localização unívoca de artefatos. Em suma, garantir que nenhum nome de artefato se repete em nenhum local da empresa e, da mesma forma, garantir uma identicação de recurso mesmo quando este seja retirado do repositório versionado. Para garantir essa qualidade, os artefatos são armazenados com um nome composto de diversos fragmentos, que correspondem à sua localização no repositório versionado. No decorrer desse capítulo, são mostrados exemplos dessa técnica.

Estrutura de diretórios

Os diretórios no repositório versionado seguem a estrutura abaixo:

Sem Formato

 $dados...................................................Diretorio do sistema operacional, a qual contem todos os dados da empresa.
  +-repositorios..........................................Nome padrao "repositorios", que indica o local onde estao todos os repositorios versionados da empresa.
     +-$grupo.............................................Tipo do repositorio, indica a finalidade do repositorio, como "public", "private" ou o nome de um cliente.
         +-$repositorio...................................Repositorio versionado, um para cada projeto da empresa.
             +-trunk......................................Diretorio principal, com artefatos em desenvolvimento ou producao.
             +-branches...................................Diretorio auxiliar, com artefatos em desenvolvimento que contem divergencias do diretorio principal.
             +-tags.......................................Diretorio imutavel com artefatos que correspondem a versoes de entrega ou versoes estaveis de recursos.

O  conteúdo dos diretórios abaixo de /trunk, /branches e /tags varia de projeto para projeto, e a estruturação deve ser acordada de antemão com a gerência do projeto, com concordância entre os perfis de arquitetos, analistas e projetistas. Diretórios iniciadios por $ (cifrão) são variáveis.

Uma possível estruturação de diretórios nesse caso é dada pela figura anexa (TODO).

Salienta-se que o uso de caracteres de acentuação, cedilhas, underscore e semelhantes devem ser evitados.

Nomes de artefatos versionados

Todos os artefatos versionados devem ser referenciados univocamente, independente de estarem ou não vinculados ao repositório. Isso garante, por exemplo, que ao receber um documento por email, este seja facilmente associado ao cliente, projeto e função (no projeto).

Para que isso seja possível, uma técnica de estruturação de nomes compostos é utilizada, conforme:

Sem Formato

 $empresa - $cliente - $projeto - [$area]+ - [$data]? - $nomeDoArtefato


Wiki Markup
Nesse modelo, $ (cifrão) significa uma variável; valores entre \[\]\+ devem ocorrer pelo menos uma vez e; valores entre \[\]? são opcionais, podendo ocorrer zero ou uma vez. Datas, como sempre, são formatadas como _aaaa.mm.dd_.

Assim, são exemplos práticos dessa nomenclatura:

3layer - 3layer - admin - estrategia - plano de negocios.doc : Plano de negócios da empresa 3Layer Tecnologia, em seu conjunto de documentos estratégicos.

3layer - targettrust - cursos - uml - 2007.11.12 - material didatico do curso 1 de uml.zip : Material didático do primeiro curso de UML no cliente Targettrust, oferecido no período de novembro de 2007.

3layer - 3layer - admin - estrategia - parcerias - lm2 - proposta de negocio.doc : Documentação de base da negociação de parceria empresarial com a LM2 Consulting.