Modelo para documento de plano de gerncia de configurao de software Objetivo:

Este documento um modelo genrico para a criao do plano de gerncia de configurao de software a ser usado nos projetos da fbrica de software. Informaes gerais de uso: 1. Para alterar os campos de autotexto, como o nome do documento, a verso ou a data, deve-se usar a opo Arquivo->Propriedades-> Personalizar . Nesta pasta esto as variveis utilizadas pelo Word. Nela os valores dos campos podem ser editados e aps realizar a edio s clicar com o boto direito do mouse sobre o autotexto desejado e clicar na opo Atualizar campo. Aps este procedimento o campo ser atualizado para o valor desejado; 2. Os corpos dos textos devem usar formatao Normal;

Histrico de revises do modelo

Verso (XX.YY) Data (DD/MMM/YYYY) Autor Descrio Localizao

00.01 00.02 00.03

30/MAR/2004 31/MAR/2004 06/ABR/2004

jmpv mscab jmpv

Draft inicial Atualizao do draft inicial

00.04 01.00 02.00 02.01 03.00

13/ABR/004 18/ABR/2004 26/MAI/2004 26/MAI/2004 31/MAI/2004

Adicionado novo logo da fbrica, pequenas modificaes no modelo baseado nas sugestes de Mrcia. aa Formatao do doc. e reviso para fechar uma verso. aa, tlvls, Verso final prpa aa Ajustes no doc. jmpv Ajustes no documento, seguindo experincias do projeto piloto jmpv Verso final

www/artifac ts/template s/ www/artifac ts/template s/

Aprovadores
Paulo Rogrio Joo Marcos Gerente de Projeto Gerente de Configurao

Mrcia Seabra Antnio Campello Alexandre Alvaro

Engenheira de Qualidade e Processo Analista de Negcios Arquiteto de Software

USINA

<Nome do Projeto> Plano de Gerncia de Configurao de Software

Verso:<Verso XX.YY> Data:<dia Ms, ano> Identificador do documento:SCMP Modelo usado:03.00 Localizao:<caminho de acesso no CVS ou URL>

<Tipo do copyright>

USINA Plano de Gerncia de Configurao de Software <Nome do Projeto>

<Verso XX.YY>, <dia Ms, ano>

Histrico de revises
Verso (XX.YY) Data (DD/MMM/YYYY) Autor Descrio Localizao

60750176.doc

<Tipo do copyright>

Pgina 4 de 16

USINA Plano de Gerncia de Configurao de Software <Nome do Projeto>

<Verso XX.YY>, <dia Ms, ano>

ndice
NDICE DE FIGURAS................................................................................................................................6 NDICE DE TABELAS................................................................................................................................7 1. INTRODUO..........................................................................................................................................8 1.1. PROPSITO................................................................................................................................................8 1.2. PBLICO ALVO..........................................................................................................................................8 1.3. ESCOPO....................................................................................................................................................8 1.4. DEFINIES, ACRNIMOS E ABREVIAES.....................................................................................................8 1.5. REFERNCIAS............................................................................................................................................8 1.6. VISO GERAL DO DOCUMENTO.....................................................................................................................8 2. ATIVIDADES............................................................................................................................................9 2.1. NOMENCLATURA E IDENTIFICAO................................................................................................................9 2.1.1. Identificador de Documento (Doc ID)..........................................................................................9 2.1.2. Nmero de verso........................................................................................................................10 2.1.3. Local de armazenamento.............................................................................................................10 2.1.4. Baselines de projeto....................................................................................................................11 2.1.5. Poltica de uso de branches.........................................................................................................12 2.1.6. Poltica de uso de branches para documentos............................................................................13 2.2. CONTROLE DE CONFIGURAO...................................................................................................................13 2.2.1. Core teams...................................................................................................................................13 2.2.2. Solicitao de mudanas.............................................................................................................13 2.3. CONTRIBUIES EXTERNAS........................................................................................................................13 2.4. AUDITORIA DE CONFIGURAO...................................................................................................................14 2.5. RELATRIOS DE CONFIGURAO.................................................................................................................14 3. PLANO DE CONTINGNCIA..............................................................................................................15 4. PROCEDIMENTOS................................................................................................................................16

60750176.doc

<Tipo do copyright>

Pgina 5 de 16

USINA Plano de Gerncia de Configurao de Software <Nome do Projeto>

<Verso XX.YY>, <dia Ms, ano>

ndice de Figuras
FIGURA 2-1 ESTRUTURA DE DIRETRIOS DO CVS.......................................................................11

60750176.doc

<Tipo do copyright>

Pgina 6 de 16

USINA Plano de Gerncia de Configurao de Software <Nome do Projeto>

<Verso XX.YY>, <dia Ms, ano>

ndice de Tabelas
TABELA 2-1 TIPOS DE ARTEFATOS.....................................................................................................10 TABELA 2-2 DETALHAMENTO DAS PASTAS DO CVS....................................................................11 TABELA 2-3 BASELINES DE PROJETO................................................................................................12 TABELA 2-4 MEMBROS DO CORE TEAM DE SCM..........................................................................13

60750176.doc

<Tipo do copyright>

Pgina 7 de 16

USINA Plano de Gerncia de Configurao de Software <Nome do Projeto>

<Verso XX.YY>, <dia Ms, ano>

1. Introduo
1.1.Propsito
Este documento apresenta os processos necessrios para gerenciar as mudanas no projeto, provendo assim uma infra-estrutura necessria para a evoluo do projeto.

1.2.Pblico Alvo
Os interessando diretamente nesse documento so todas as pessoas envolvidas no projeto, em especial, aqueles envolvidos nas atividades de engenharia do projeto (principalmente programao).

1.3.Escopo
Neste documento esta detalhada toda a infra-estrutura que ser utilizada durante o projeto.

1.4.Definies, Acrnimos e Abreviaes.

<Nesta seo sero descritos as abreviaes, definies e acrnimos relevantes ao documento em ordem alfabtica. Segue uma lista de definies, acrnimos e abreviaes usados neste documento.> CVS SCMP Control Version System. Abreviatura genrica para sistemas de controle de verso (configurao) de software. Software Configuration Management Plan (Plano de gerncia de configurao de software)

1.5.Referncias
Segue a lista de referencias deste documento. [1] [2] [3] WinCVS official website, www.wincvs.org, acesso em maro/2004. Documento de Processo da USINA, Verso <01.00>. Localizao: <localizao>. Relatrio de Auditria do Projeto, Verso <01.00>. Localizao: <localizao>.

1.6.Viso geral do documento

O presente documento est estruturado assim: Seo 2: apresenta o ambiente no qual o projeto estar inserido, as atividades a serem realizadas pelo plano de gerncia de configurao; Seo 3: apresenta um plano de contingncia visando superar alguns problemas que podem surgir durante o projeto, como indisponibilidade de acesso ao ambiente do projeto e perda de dados; e Seo 4: apresenta os procedimentos de gerncia de configurao.

60750176.doc

<Tipo do copyright>

Pgina 8 de 16

USINA Plano de Gerncia de Configurao de Software <Nome do Projeto>

<Verso XX.YY>, <dia Ms, ano>

2. Atividades
Nesta seo sero apresentadas algumas atividades a serem seguidas pelos colaboradores do <Nome do Projeto>.

2.1.Nomenclatura e identificao
2.1.1. Identificador de Documento (Doc ID)
<Defina um esquema de nomenclatura de documentos prprio para o projeto, ou aceite o esquema descrito nesta seo> Todos os itens de configurao do projeto, com exceo do cdigo fonte, devem possuir um identificador de documento (doc_id). Os doc_ids devem seguir o seguinte esquema de nomenclatura: <nome_projeto>_<tipo_artefato>_<data_da_criao>[_<descrio>] Onde: <nome_projeto> <tipo_artefato> Nome do projeto em letras maisculas; tipo do artefato, conforme apresentado na Tabela 2-1;

<data_da_criao> momento da criao do arquivo no formato AAAAMMDD; <descrio> breve descrio do arquivo, pode ser o ttulo do documento. Esta descrio s pode conter caracteres maisculos e no acentuados (A-Z), nmeros (0-9), hfen (-) e sublinhado (_). Notas: Idealmente no deve ultrapassar 50 caracteres. Este campo opcional, caso seja omitido, a identificao do arquivo termina no ltimo dgito da data da criao. Para artefatos nicos de um projeto, como os planos, a descrio pode ser omitida, no caso de artefatos passveis de ter vrias instancias, como relatrios, por exemplo, ento necessrio o preenchimento deste campo. tipo _artefato SPMP SCMP SQAP STP MEET RPT ARCH MKT REQ PRC TST

Artefato Plano de Gerncia de Projeto de Software Plano de Gerncia de Configurao de Software Plano de Garantia da Qualidade de Software Plano de Testes do Software Pauta e Ata de Reunio Relatrios (status, mtricas, auditorias, resultado de testes) Documentos de Arquitetura Artefatos Comerciais Documentos de Requisitos Documentos de Processo Documentos de Testes

60750176.doc

<Tipo do copyright>

Pgina 9 de 16

USINA Plano de Gerncia de Configurao de Software <Nome do Projeto>

<Verso XX.YY>, <dia Ms, ano>

Tabela 2-1 Tipos de artefatos Arquivos de cdigo fonte so identificados pelo seu nome completo, ou seja, o nome do pacote, seguido por ponto (.) e o nome da classe.

2.1.2.

Nmero de verso

<defina padro para versionamento dos artefatos ou aceite a sugesto definida nessa seo> Todos os artefatos, excluindo cdigo e relatrios, devem possuir um numero de verso seguindo o padro a seguir: XX.YY Onde: XX YY Nmero da verso do documento Nmero de rascunho (draft) do documento

A evoluo do nmero de verso segue as seguintes regras: A primeira verso do documento deve ser 00.01; A cada modificao do documento, o valor YY deve ser incrementado; Aps cada aprovao do documento, sua verso XX deve ser incrementada em um, e o valor YY volta a 00, formando uma verso cheia ou oficial;

considerada uma aprovao do documento: a) Aprovao do documento aps uma reviso; b) Aprovao por pelo menos dois (2) membros do core group responsvel pelo artefato respectivo.

2.1.3.

Local de armazenamento

Esta seo apresenta onde so armazenados os artefatos do projeto <Nome do Projeto>. interessante apresentar tanto uma viso grfica da estrutura de diretrios (arvore de diretrios) quanto uma descrio mais detalhada, por exemplo, usando uma tabela. Esta seo apresenta onde so armazenados os artefatos do projeto <Nome do Projeto>.

60750176.doc

<Tipo do copyright>

Pgina 10 de 16

USINA Plano de Gerncia de Configurao de Software <Nome do Projeto>

<Verso XX.YY>, <dia Ms, ano>

Figura 2-1 Estrutura de diretrios do CVS Diretrio code bin build lib model release src docs design marketing requirements scm spm sqa test reports audit test Descrio Contm diretrios para o cdigo fonte, bibliotecas utilizadas e scripts de compilao. Arquivos binrios e executveis Scripts de compilao (build.xml). Bibliotecas externas utilizadas pelo projeto. Modelos UML Verses de release do projeto O cdigo fonte est localizado nesta pasta ou em sub-pastas. A documentao para o projeto est nas sub-pastas de docs Artefatos de design, como modelos UML e descries da arquitetura do sistema. Documentos de marketing como a proposta comercial, resposta ao RFP, e SLA. Documentos de requisito. Documentos de gerncia de configurao de software. Documentos de planejamento. Documentos de garantia de qualidade de software. Documentos de teste para o projeto, incluindo documentos de procedimentos de testes, planos de teste, etc. Relatrios do projeto Relatrios de auditoria do projeto Relatrios de teste do projeto Tabela 2-2 Detalhamento das pastas do CVS

2.1.4.

Baselines de projeto

<use essa seo para descrever que baselines sero gerados no projeto> Os baselines de projeto so descritos na Tabela 2-3.

60750176.doc

<Tipo do copyright>

Pgina 11 de 16

USINA Plano de Gerncia de Configurao de Software <Nome do Projeto>

<Verso XX.YY>, <dia Ms, ano>

Baseline

Descrio

Formato
Tabela 2-3 Baselines de projeto

2.1.5.

Poltica de uso de branches

<Defina nessa seo a poltica para uso de branches, ou aceite a poltica descrita nas sub-sees a seguir>

2.1.5.1.

Branch principal (main)

o branch principal do projeto. Apenas verses baselined devem ser integradas a este branch, isso garante que este branch conter um cdigo testado e funcional ou documentos revisados e aprovados.

2.1.5.2.

Branch de integrao

Os branches de integrao so utilizados para integrar um conjunto de mudanas antes de integr-las ao branch principal. Um conjunto extensivo de testes deve ser realizado antes desta integrao, assim, o branch principal conter apenas cdigo j testado, e documentos revisados. O label de um branch de integrao segue o seguinte padro: <nome_projeto>_int_<build> Onde: <nome_projeto> <build> Nome do projeto em letras maisculas; Nmero da build.

2.1.5.3.

Branch de desenvolvimento

neste branch onde todos os desenvolvimentos devem ser feitos. Ele deve ser sempre criado a partir de um baseline de release (branch principal). Antes de integrar o cdigo de um branch de desenvolvimento no branch de integrao, o engenheiro deve garantir que o cdigo esteja atualizado com o ultimo baseline e ento testar novamente a modificao para garantir que continua funcionando. <nome_projeto>_dev_<issue_id>_<descrio> Onde: <nome_projeto> <issue_id> <descrio> Nome do projeto em letras maisculas; Identificador da issue sendo resolvida neste branch; Breve descrio sobre as mudanas feitas.

Patches, vindos de colaboradores externos, devem ser inserido em seus prprios branches de desenvolvimento, e ento integradas em branches de integrao.

60750176.doc

<Tipo do copyright>

Pgina 12 de 16

USINA Plano de Gerncia de Configurao de Software <Nome do Projeto>

<Verso XX.YY>, <dia Ms, ano>

2.1.6.

Poltica de uso de branches para documentos

<Defina nessa seo a poltica para uso de branches em documentos, ou aceite a poltica descrita nas sub-sees a seguir. Esta seo opcional uma vez que a poltica pode ser a mesma que acima.> Documentos no utilizaram branches. Antes de criar uma nova verso preciso fazer um check out no documento e um lock (travamento), para impedir o trabalho paralelo no documentos.

2.2.Controle de Configurao
2.2.1. Core teams
Cada projeto deve ter um core team definido para cada papel. Estes grupos decidiro a necessidade e urgncia da implementao de solicitaes de mudanas. A formao destes core teams esto descritas no processo de desenvolvimento de software 1.5. A formao do Core Team de gerncia de configurao de software mostrado na Tabela 2-4. Nome e-mail para contato

Tabela 2-4 Membros do Core Team de SCM

2.2.2.

Solicitao de mudanas

Mudanas nos itens de configurao do projeto devem estar sempre associadas a solicitaes de mudanas. Esta a fora motriz por trs do processo.

2.2.2.1.

Solicitaes de mudanas devem ser utilizadas por um gerenciador de mudanas (i.e: bugzilla, issue tracker). Devem ser aprovadas pelo core team responsvel pelo artefato em questo. <esta seo deve descrever como preencher os dados de uma solicitao de mudana na ferramenta usada no projeto.>

Preenchendo uma solicitao de mudanas

2.2.2.2. 2.2.2.3.

Estados de uma solicitao de mudana Ciclo de vida de uma solicitao de mudana

<descreva estados de uma solicitao de mudana>

<descreva ciclo de vida de uma solicitao de mudana>

2.3.Contribuies externas
<descreva como as contribuies externas devem ser feitas, como so aceitas, etc.>

60750176.doc

<Tipo do copyright>

Pgina 13 de 16

USINA Plano de Gerncia de Configurao de Software <Nome do Projeto>

<Verso XX.YY>, <dia Ms, ano>

2.4.Auditoria de configurao
Auditorias devem ser realizadas para cada ciclo do processo de desenvolvimento de forma a assegurar que os processos de gerncia de configurao esto sendo seguidos e devem ser reportados no relatrio de auditoria de artefatos do projeto 1.5

2.5.Relatrios de configurao
A cada release deve ser gerado um documento de release notes, contendo quais so as modificaes adicionadas quela verso (incluindo o nmero do bug), alm de informao til para os usurios.

60750176.doc

<Tipo do copyright>

Pgina 14 de 16

USINA Plano de Gerncia de Configurao de Software <Nome do Projeto>

<Verso XX.YY>, <dia Ms, ano>

3. Plano de Contingncia
<descreva o plano de contingncia>

60750176.doc

<Tipo do copyright>

Pgina 15 de 16

USINA Plano de Gerncia de Configurao de Software <Nome do Projeto>

<Verso XX.YY>, <dia Ms, ano>

4. Procedimentos
Esta seo descreve alguns procedimentos de gerncia de configurao para o projeto.

60750176.doc

<Tipo do copyright>

Pgina 16 de 16