-
Notifications
You must be signed in to change notification settings - Fork 0
Processo ‐ Documentation
Diretrizes: O que Deve Ser Documentado Nesta Seção
Esta área é dedicada a descrever como a equipe executa o seu trabalho do ponto de vista operacional, mapeando o passo a passo das atividades e o fluxo das tarefas. O foco aqui é exclusivamente a nossa forma de trabalhar. Temas de DevOps (como estratégias de branch, padrões de commit e configurações de pipeline) não devem ser incluídos.
A documentação deve sempre apresentar:
- Fluxo de Trabalho: Como as demandas chegam, são analisadas, desenvolvidas e concluídas, garantindo o alinhamento de todos.
- Tecnologias de Apoio: Ferramentas de gestão e acompanhamento utilizadas no dia a dia, explicando como auxiliam o processo sem entrar no mérito de infraestrutura.
- Implementação e Entregas: Como o trabalho é validado e registrado, incluindo os critérios de aceite e a rastreabilidade das tarefas.
- Validações e Testes: Quais revisões, conferências e garantias de qualidade são aplicadas antes de dar uma entrega como finalizada.
Em resumo: o Processo detalha a organização e execução do trabalho; a automação técnica e o versionamento pertencem à dimensão de DevOps.
Este documento detalha o papel e as responsabilidades operacionais de [Nome da Função – ex: Database, Requirement Tracking, CI] dentro da equipe SQLutions.
- Descrição da Rotina: [Detalhe o passo a passo das atividades desta função. Como uma nova demanda chega até os responsáveis? Como ela é analisada, executada e, finalmente, dada como concluída? Seja claro para que toda a equipe entenda a organização do trabalho.]
-
Inventário de Ferramentas: [Mapeie os sistemas, softwares, frameworks ou plataformas de acompanhamento adotados por esta função.]
-
Propósito de Uso: [Explique o papel de cada ferramenta na rotina da equipe. Como elas dão suporte direto ao trabalho operacional?]
-
Por que foram escolhidas: [Justifique a adoção destas tecnologias. Elas facilitam a integração, aumentam a qualidade ou otimizam o tempo da equipe?]
-
Critérios de Aceite:
- [Ex: A ferramenta deve estar homologada e adotada por toda a equipe.]
- [Ex: A sua utilização deve ser estável e os acessos devem estar claros para os membros.]
-
Descrição do Fechamento: [Descreva de que maneira as atividades desta função são validadas e formalmente entregues. Como o time tem certeza de que o trabalho atendeu aos padrões estabelecidos e está pronto para uso?]
-
Critérios de Aceite da Entrega:
- [Ex: Os requisitos iniciais da demanda foram integralmente atendidos.]
- [Ex: A entrega foi documentada, disponibilizada no local correto e pode ser rastreada.]
- Descrição da Checagem: [Relate quais verificações de qualidade ou métodos de teste são aplicados nesta rotina (por exemplo: Code Reviews, testes unitários, validações em pares ou conferência de checklists). O objetivo é esclarecer como a função se previne contra erros antes de finalizar a tarefa.]