Por que você não faz a Documentação do seu jogo?

Criar a Documentação do código costuma ser uma tarefa vista como “opcional” por muitos desenvolvedores iniciantes.

No entanto, essa prática é fundamental para manter a saúde geral e manutenção do projeto a longo prazo.

E a seguir vamos explorar os principais problemas que podem surgir quando a documentação é negligenciada!

Documentação: Código duplicado

Imagine que você desenvolveu uma classe responsável pela movimentação dos personagens em um jogo.

E esta classe possui métodos, variáveis e lógica específicos para definir como o personagem se desloca, pula ou se agacha.

No entanto, você decidiu não documentar como esses métodos funcionam.

E até quais parâmetros precisam ser ajustados para personalizar a movimentação de personagens específicos.

Porém, um segundo desenvolvedor entra no projeto e precisa ajustar um detalhe da movimentação.

E ele não consegue entender como a sua classe original funciona, o resultado?

Ele cria novas classes que implementam uma lógica similar desnecessária, para realizar as mesmas tarefas.

Consequências da falta de Documentação

Este tipo de duplicidade de código gera retrabalho, aumenta a complexidade do projeto e prejudica a organização.

E classes duplicadas dificultam o balanceamento e ajustes finos, em diferentes aspectos do jogo.

Pois, qualquer mudança, será necessário alterar múltiplas versões da mesma funcionalidade.

E a documentação evitaria essa situação ao fornecer uma referência clara para qualquer desenvolvedor.

Por exemplo, mostrando como a movimentação foi estruturada, onde realizar ajustes, como chamar e usar seus métodos, etc.

Limitando expansões e vendas do game

Outro ponto crítico onde a falta de documentação causa problemas é na portabilidade.

Pois, quando se decide portar um jogo para diferentes plataformas, há diversas considerações a serem feitas.

Por exemplo, como adaptar os controles, otimizar o desempenho e ajustar o sistema de salvamento.

E sem a documentação, os desenvolvedores responsáveis pelo porting, não terão um guia sobre quais classes ou métodos cuidam dessas funcionalidades.

E até mesmo quando o jogo é um sucesso é precisa receber atualizações de conteúdos e novos programadores.

Ou seja, a depender do Upgrade ele pode ser inviável, ou até gerar mais duplicação de funções desnecessárias.

E é obvio que a falta de conteúdo, ou a não possibilidade do porting, vai afetar diretamente nos lucros do jogo.

Perda de conhecimento

É comum que desenvolvedores entrem e saiam das equipes, ou que a equipe sofra reestruturações.

E quando um desenvolvedor sai, ele leva consigo o conhecimento sobre o código que escreveu.

E essa perda de conhecimento torna a continuidade do projeto, mais complexa.

Pois, o novo desenvolvedor terá que aprender o funcionamento de cada sistema, estudar as classes e compreender tudo do zero.

Por isso, é necessário que tudo seja documentado para evitar perder tempo reaprendendo, seu próprio sistema.

Ou seja, a documentação evita que o conhecimento fique preso com uma pessoa específica, mesmo com mudanças na equipe.

Como documentar de forma eficiente?

Aqui vão algumas dicas simples:

1. Descreva o propósito de cada classe e função, em cada classe, inclua uns comentários e explique o que elas fazem e quais parâmetros recebem.
2. Use comentários para esclarecer, especialmente quando uma lógica for complexa de entende.
3. Documente os principais parâmetros e variáveis mais relevantes, especialmente se eles afetarem aspectos de jogabilidade.
   Por exemplo, a velocidade de movimentação ou a intensidade de um ataque.
4. Organize a documentação externa: se o projeto for grande, considere criar uma documentação externa.
   Como, por exemplo, um arquivo README.md, com explicações sobre as estruturas mais complexas, e sistemas principais.

A documentação do código pode parecer um passo adicional que “atrapalha” o desenvolvimento.

No entanto, ela é uma prática essencial para garantir a longevidade do projeto.

Pois, torna ele mais acessível para novos desenvolvedores, facilitando o trabalho de membros futuros da equipe.

Quer aprender a criar seu primeiro jogo, em poucos dias, saindo do zero e por um preço irrecusável?

Conheça o curso Start Gamedev que foi criado justamente com o intuito de te ajudar a dar os seus primeiros passos no desenvolvimento de jogos.

Clique nesse texto para garantir sua vaga, ou assista a um video review logo abaixo!