Executando verificação de segurança...
2
Mikw
1 min de leitura ·

Documentação como posso implementar?

Hoje tenho um PEQUENO problema na minha equipe, estamos migrando sistemas legados para novas tecnologias, além de desenvolver outros projetos, porém estamos muito acoplados ao banco de dados devido a processos antigos, algumas, jobs executadas via bancos, envio de email via banco etc...
Hoje temos uma pessoa responsável para documentar os projetos, porém sinto que não estamos o acionando bem.
Como posso não para os meus projetos para documentar e passar para ele de uma forma rápida e simples o que mudou, o que foi feito e que está sendo modificado para um melhor implementação?
Lembrando que 90% das coisas não estão documentadas, não só no nosso projetos, mas no todo.

Carregando publicação patrocinada...
2

Sei bem como é, aqui também estou na mesma.
Cara, o que passou, passou, vai ser difícil e trabalhoso documentar os projetos antigos, tenta documentar os novos.

1

É difícil lidar com isso, eu estou tentando tomar a rédia dessa parte, porque eu mesmo às vezes me perco nos projetos sem saber o que esta acontecendo, hoje tendo em vista que eu sou o mais preocupado com isso estou tentando fazer isso, mas não tenho experiencia em documentar projetos, tem algum local onde eu posso pegar alguma informação.

1

Para passar essas informações, no mínimo deveria existir um changelog, se não tiver, vai ter que ir pelos commits, pegando as datas e mensagens e montar um changelog, pode ser mais técnico no começo só pra ter. Depois pode documentar as mudanças com prints, vídeos e descrições maiores.

1

Entendi, nesse caso tem alguma ferramenta para colocar esses changelogs, ou seria bom deixar a exemplo em um notion, não ficaria muito grande?