Modelo de Guia de Integração
Ao desenvolver um documento de integração para uma equipe, ele deve conter detalhes do escopo de envolvimento, processos da equipe, base de código, padrões de codificação, acordos da equipe, requisitos de software e detalhes de configuração. O guia de integração pode ser usado como um índice para o conteúdo específico do projeto, se já existir em outro lugar. Permitir que este guia seja utilizado como uma base com os links ajudará a manter o guia conciso e eficaz.
Visão Geral e Objetivos
- Liste algumas frases explicando o resumo de alto nível e o escopo do envolvimento.
- Considere adicionar qualquer contexto e antecedentes adicionais conforme necessário.
- Inclua a proposta de valor do projeto, objetivos, como se parece o sucesso e o que a equipe está tentando alcançar e por quê.
Contatos
- Liste alguns dos principais contatos para a equipe e o projeto como um todo, como o Líder de Desenvolvimento e o Proprietário do Produto.
- Considere incluir as funções desses principais contatos para que a equipe saiba com quem entrar em contato dependendo da situação.
Acordo da Equipe e Código de Conduta
- Inclua o código de conduta ou acordo da equipe que define um conjunto de expectativas de cada membro da equipe e como a equipe concordou em operar.
- Modelo de Acordo de Trabalho - acordo de trabalho
Configuração do Ambiente de Desenvolvimento
- Considere adicionar etapas para executar o projeto de ponta a ponta. Isso pode estar na forma de uma página wiki separada ou documento que pode ser vinculado aqui.
- Inclua qualquer software que precisa ser baixado e especifique se é necessária uma versão específica do software.
Blocos de Construção do Projeto
- Isso pode incluir uma descrição mais detalhada com diferentes áreas do projeto para ajudar a aumentar o entendimento do projeto.
- Pode incluir diferentes seções sobre os vários componentes do projeto, incluindo implantação, teste de ponta a ponta, repositórios.
Recursos e Links Úteis
- Isso pode incluir quaisquer links adicionais para documentos relacionados ao projeto.
- Pode incluir links para itens do backlog, itens de trabalho, páginas de wiki ou histórico do projeto.