Disclaimer: Este texto foi originalmente escrito por mim durante o meu período de trabalho na TauGC Bioinformatics. Embora eu seja o autor, os direitos de propriedade pertencem à TauGC Bioinformatics. Para acessar a publicação original, clique aqui

Saiba mais sobre o framework que auxilia na construção de documentações

Autor | Pedro Medeiros

Na Bioinformática, a criação de conhecimento e ferramentas é apenas metade do processo. O desafio verdadeiro é transmitir esse conhecimento e treinar pessoas para reproduzi-lo - afinal, a utilidade de um software depende diretamente disso. Aí reside a necessidade crítica de uma documentação técnica precisa e eficiente.

O Framework Diátaxis surge como uma resposta a essa necessidade, organizando como registramos nossos esforços técnico científicos de uma maneira pragmática, escalonando vários níveis entre teoria e prática.

Do site da framework, em tradução livre:

“No Diátaxis são identificadas quatro modalidades de documentação - tutoriais, guias práticos, referências técnicas e explicações. Sua estrutura é derivada da relação entre elas. Cada uma dessas modalidades responde a uma necessidade do usuário, cumpre um propósito e requer uma abordagem diferentes para sua criação.”

A seguir, gostaria de destacar 5 pontos que vimos como vantagens na TauGC ao implementar esse framework:

1. Estabelecimento de um padrão
   A implementação do Framework Diátaxis nos permitiu estabelecer um padrão para nossos esforços de documentação, promovendo consistência e clareza. Isto facilita a compreensão e o acesso à informação por parte de todos os envolvidos.

2. Níveis crescentes de detalhamento
   O Diátaxis é construído com uma abordagem estratificada, permitindo níveis progressivamente mais detalhados de documentação. Isso possibilita o atendimento de necessidades variadas, desde um panorama geral até detalhes técnicos complexos sem que essas coisas se misturem.

3. Assertividade de objetivos
   O Framework Diátaxis nos ajuda a definir claramente os objetivos de cada tipo de documentação, tornando o propósito de cada documento mais claro para os usuários e para nós mesmos. Dessa forma a comunicação fica clara e objetiva, diminuindo a distância entre a dúvida e a resolução.

4. Versatilidade
   Apesar da sugestão de nomes e estrutura, o diatáxis permite que você o adapte de maneira bastante flexível. Você não precisa manter as nomenclaturas sugeridas, embora elas sejam boas e auto explicativas, mas pode contextualizar de acordo com sua situação.

5. Economia no pós venda e suporte
   Com uma documentação mais eficiente e clara, conseguimos diminuir a demanda por suporte pós-venda. Isto se traduz em economia de tempo e recursos, permitindo que nossa equipe concentre esforços em desenvolvimento e inovação e o cliente possa rapidamente se apropriar da ferramenta.

Como uma empresa focada em bioinformática, compreendemos a importância crucial da documentação técnica. Nesse sentido, sugerimos a adoção do Framework Diátaxis, visando aprimorar a documentação e passagem de conhecimento. Encorajamos todos os profissionais da área a valorizar a documentação eficiente como parte integrante do progresso científico.

Saiba mais:

Diatáxis