História de um desenvolvedor SI
#10. O que é documentação em um projeto SI?

Em projetos si, você precisa enviar documentos ao cliente como prova de que o projeto foi bem feito.

Começando pela proposta, passando pelo documento de definição de tela, especificações, manual do usuário, etc., existem documentos que precisam ser escritos em cada fase do projeto, desde a proposta do projeto até o design, desenvolvimento, teste, abertura e operação, que geralmente ficam a cargo de desenvolvedores juniores.

Ao escrever a documentação, você pode se perguntar se foi isso que você queria ser quando cresceu, um desenvolvedor ou um funcionário administrativo. Além disso, na Coreia do Sul, é comum concentrar a documentação a ser realizada em cada fase próximo ao fim do projeto. O motivo é o seguinte:

• O prazo do projeto é curto, então você precisa fazê-lo o mais rápido possível e criar documentos realistas para concluir o projeto dentro do prazo.
• Mesmo que você o crie passo a passo, os requisitos serão adicionados e modificados, então é mais rápido criar tudo de uma vez e ajustá-lo a isso, em vez de criar e modificar.

É irônico, mas é uma maneira que evoluiu naturalmente na cultura si da Coreia.

Existem muitas ferramentas para desenhar documentos de definição de tela, mas você pode ver um cenário mágico em que você captura a tela operacional concluída e cria documentos de definição de tela a partir dela.

Desenvolvedores geralmente odeiam a ideia de escrever documentos, mas e aí? Você é novato.

Os estagiários são os mais fáceis de serem responsabilizados pela documentação. Você não pode fazer eles começarem a desenvolver imediatamente, então você os coloca para escrever documentos.

Afinal, você terá que ensinar seu sucessor mais tarde, então aproveite a oportunidade para fazê-lo agora.