Antes de falar sobre documentação e sua importância, é interessante falar sobre o seu objetivo, que é a transmissão de conhecimento. Segundo estudos, existem dois tipos de conhecimento: o conhecimento tácito e o conhecimento explícito. O tácito nada mais é que o conhecimento relacionado às experiências, práticas e vivências das pessoas durante a vida, é aquele conhecimento transmitido em fragmentos de pessoa para pessoa, e por esse mesmo motivo é mais fácil de se perder. Já o conhecimento explícito, é um conhecimento mais fácil de ser transmitido e pode ser formalizado por meio de textos, vídeos, imagens, entre outros, e é aqui que entra a documentação de software.

É importante definir sobre como estes conhecimentos são transmitidos, e entender qual tipo de transmissão as empresas usam atualmente. É muito comum que seja dita a seguinte frase para um novo colaborador ou para alguém que está aprendendo uma nova função:

“Durante um determinado tempo você vai acompanhar este colaborador, ele é muito experiente nesta função e vai te ajudar muito no seu aprendizado ou treinamento”.

Com isso, aborda-se o primeiro tópico, que é a transmissão de conhecimento.

FASES DE TRANSMISSÃO DE CONHECIMENTO

Segundo Takeuchi, esta é a primeira fase de transmissão de conhecimento, que é a Socialização (Transmissão do conhecimento de Tácito para Tácito), onde é transmitido entre pessoas, e justamente por isso, pode se perder ou sofrer alterações facilmente. Semelhante em como ocorre a brincadeira do “telefone sem fio”, uma informação sai da fonte de um jeito e passa por tantas pessoas que chega no final totalmente distorcida.

Com isso, surge também outro problema, pois colaboradores com conhecimentos avançados em determinados processos podem sair de férias, ficar doentes ou simplesmente não fazer mais parte da empresa, fazendo com que a organização, além de prejudicada, perca rendimento, visto que as tarefas realizadas por eles não são documentadas, e serão realizadas por outros colaboradores de formas divergentes, sendo talvez mais trabalhosa pela falta de experiência.

E se houvesse registros de como funciona cada  tarefa? Assim inicia-se a segunda fase de transmissão do conhecimento, a Externalização (Transmissão do conhecimento de Tácito para Explícito), onde é registrado e formalizado em documento todo conhecimento importante para a realização das atividades que os colaboradores possuem e compartilham. Esse desafio ocorre frequentemente nas organizações, principalmente quando um novo colaborador precisa utilizar um sistema.  É necessário ao colaborador conhecê-lo, saber acessá-lo, usar as funcionalidades, entender as regras de negócio, dentre outras funções, ele necessita aprender a usá-lo para executar seu trabalho. É facilitador quando um funcionário novo, ou até mesmo àqueles que trabalham a anos com o sistema, podem acessar um documento e nele tirar suas dúvidas sem precisar perguntar a alguém. 

Nessa etapa, é importante que as empresas criem um registro textual do seu software, ou seja, uma Documentação. Nela, devem constar todas as informações necessárias para compreensão e utilização do software, exercendo um papel de ferramenta de auxílio na busca por questionamentos dos usuários durante seu uso. 

Mas boa parte das empresas não veem isso como prioridade e não documentam seus sistemas. Fazendo com que as informações sejam transmitidas oralmente, ficando o conhecimento restrito com determinados colaboradores, e assim gerando problema principalmente quando um funcionário deixa de fazer parte da equipe. Além disso, também há dificuldade quando se trata de treinamentos, tendo que ocupar um grande tempo de um colaborador somente para auxílio do novo funcionário.

Por fim, quando há processos documentados, ocorre que os documentos estão distribuídos em diversas formas: alguns estão na nuvem, outros estão impressos e outros ficam virtualmente no computador dos colaboradores, ou seja, não há organização nem padronização, dificultando assim a manutenção e a disseminação do conhecimento. Assim, descreve-se a terceira fase de transmissão do conhecimento, que é a Combinação (Transmissão do conhecimento de Explícito para Explícito), onde é possível utilizar toda a documentação exemplificada anteriormente, analisar, descrever, padronizar e organizar os documentos de maneira que fique mais fácil o acesso e manutenção a todos os colaboradores.

Depois de fomentar o conhecimento por meio da socialização das pessoas, documentar este conhecimento e organizá-lo, a última fase da transmissão do conhecimento é a Internalização (Transmissão do conhecimento de Explícito para Tácito), onde encerra o ciclo e, ao mesmo tempo,  inicia-se novamente, pois o conhecimento que foi documentado é transmitido para novos colaboradores que terão novas perspectivas e possibilidade de sugerir novas ideias.

DOCUMENTAÇÃO DE SOFTWARE

A documentação de software é uma etapa do desenvolvimento do produto que corresponde em registrar de forma textual instruções, regras e qualquer informação essencial sobre um sistema. Ou seja, é conhecimento transcrito, padronizado e organizado. Uma documentação de fácil acesso ajuda a empresa a ganhar tempo, pois não necessita da alocação de um colaborador em tempo integral para treinar outro, já que todas as explicações e regras estão na documentação.

Os benefícios em se ter uma documentação são vários, tais como minimizar retrabalhos, ter uma fonte de informação confiável sobre o software e até mesmo formar um ambiente colaborativo que ajuda a evitar o retrabalho. Assim, uma boa documentação deve ser capaz de ajudar nas etapas de análise, desenvolvimento, testes e manutenção de software, bem como ser capaz de auxiliar usuários e demais pessoas interessadas em conhecer mais sobre o sistema e seus processos relacionados.

A documentação do software é uma segurança tanto para os usuários que utilizam o sistema como para o time que trabalha no projeto, onde conseguem consultar todo o conhecimento do sistema, desde como ele funciona até as regras de negócio. Porém, frequentemente acaba não sendo uma preferência, principalmente porque o time técnico prioriza muito mais colocar a mão na prática e desenvolver códigos, do que pensar na documentação do sistema. Porém, mesmo que muitas vezes não seja uma prioridade, essa pode ser uma forma de economia (de tempo e dinheiro) e qualidade do software, visto que documentar uma nova funcionalidade pode retardar o time por uma semana ou duas, mas não documentar retarda o time sempre que alguém necessitar desta informação, tanto no desenvolvimento, nos testes e até mesmo na compreensão e suporte. O tempo investido na documentação nunca é desperdiçado.

A importância de ter uma documentação clara, objetiva e de fácil acesso a todos os envolvidos em um projeto fez com que a Testing Company desenvolvesse uma ferramenta para construção de uma documentação baseada nesses preceitos, fazendo com que o usuário encontre facilmente o conteúdo no qual precisa.

Já se perguntou em que fase do conhecimento está a sua empresa? Não sabe por onde começar? Não se preocupe, a Testing Company oferece soluções para documentação como também serviços em Teste e Qualidade de Software. Chame a gente, será um prazer atender você!