Quando pensamos na documentação de alguma informação, sempre imaginamos que esse processo seja organizado, centralizado e acessível. É aí que o Single Source of Truth ou SSoT aparece!
Um bom exemplo para imaginar a atuação do SSoT é o trabalho de Technical Writers. Essa equipe precisa reunir informações dos times de engenharia para desenvolver documentações de software, ter uma base de conhecimento vai auxiliar muito nesse processo.
Para conhecer mais sobre o tema, neste artigo, vamos apresentar o que é o Single Source of Truth e quais são seus principais benefícios no dia a dia de uma empresa que desenvolve produtos digitais.
O que é Single Source of Truth (SSoT)?
Single Source of Truth (SSoT) ou Fonte Única da Verdade é um termo utilizado para se referir ao conceito de gestão do conteúdo a partir de uma ferramenta única. Segundo esse conceito, então, todo o conteúdo (técnico e não técnico) de uma empresa deve ser centralizado em uma base de conhecimento.
No dia a dia dos times de documentação, por exemplo, alguns dos maiores problemas enfrentados pelo time de Technical Writers (TWs) são: informações duplicadas, descentralizadas e desatualizadas, que geralmente são causadas pela ocorrência do fenômeno de silos organizacionais.
Muitas vezes, isso resulta em frustração do público-alvo, em razão da dificuldade, ou até mesmo impossibilidade, de localizar a informação desejada.
No entanto, isso não quer dizer que a aplicação do Single Source of Truth esteja restrita à utilização de uma única ferramenta para todas as documentações da empresa, até porque cada time e produto possuem peculiaridades e diferentes necessidades em relação à disponibilização do conteúdo. Então, esse conceito também pode dar origem aos chamados hubs de documentação.
Os hubs nada mais são do que plataformas, através das quais o público-alvo é redirecionado ao conteúdo que procura. A ideia, portanto, é criar um ponto de centralização de conhecimento que sirva como referência, para garantir que todo mundo tenha acesso às mesmas informações.
Esse conceito é um dos pilares da metodologia de DocOps, vamos conhecer mais sobre ela!
O que é DocOps?
O conceito de DocOps (Documentation Operations) ou Operações de Documentação surgiu da metodologia DevOps e seu objetivo é o mesmo de seu precursor. No entanto, o DocOps é voltado ao desenvolvimento de documentação, e não de software.
As práticas de DocOps estão diretamente ligadas à infraestrutura do processo de documentar e visam a adoção de um conjunto de práticas de automatização e integração desse processo, de modo a tornar o conteúdo escalável e sustentável.
Isso significa que durante a atividade de documentar são adotadas práticas e ferramentas voltadas ao ciclo de vida da documentação, com foco em garantir que todo o público-alvo tenha acesso ao mesmo conteúdo, e que ele esteja sempre atualizado.
Para que a aplicação dessa metodologia funcione corretamente, é imprescindível que haja colaboração de todo o time envolvido no desenvolvimento do produto, principalmente quando se tratar de times grandes e multidisciplinares.
O time de Technical Writing é responsável pela adoção de boas práticas e por garantir a qualidade da documentação, enquanto o time de engenharia deve trazer os detalhes técnicos do conteúdo a ser documentado.
As etapas desse processo estão ilustradas no diagrama abaixo:
Exemplo do dia a dia
Digamos que uma determinada empresa disponibilize suas APIs em uma plataforma voltada ao público-alvo, nesse caso, pessoas desenvolvedoras. Dentre as APIs disponibilizadas, uma delas possui diversas versões, sem uma indicação clara de qual é a mais recente.
Além disso, não há uma sessão de release notes na documentação, ou seja, não há o detalhamento do histórico de atualizações. Essa situação gera dúvidas durante a utilização daquela API, pois não se sabe se a versão utilizada é a mais recente.
Isso viola os requisitos mínimos de uma documentação de qualidade: fácil de usar, fácil de entender e fácil de encontrar. Por isso é imprescindível que o processo de atualização de um produto envolva também a disponibilização de release notes (que fazem parte da documentação técnica).
Esse processo pode ser realizado manualmente ou de forma automatizada, o que importa é garantir que todo mundo tenha acesso ao mesmo conteúdo e que ele não gere dúvidas durante a utilização do produto.
Nesse sentido, enquanto o SSoT preza pela usabilidade da documentação, o DocOps tem o papel operacional de garantir que os procedimentos adotados sejam eficientes para que o objetivo seja alcançado.
Vantagens do Single Source of Truth
A adoção das boas práticas do SSoT é essencial para a usabilidade do produto, mas os benefícios também se refletem diretamente para os times e a empresa como um todo. Os principais benefícios são:
Evitar perda de conhecimento
Definir o local exato onde as informações devem ser documentadas evita que o conhecimento seja perdido, duplicado, descentralizado e adulterado. Com isso, o risco de se perder aquela informação, ou aquele conhecimento, é mitigado.
Facilitar a localização de informações
Uma vez que se define onde cada tipo de informação deve ser documentada, a localização de conteúdo se torna intuitiva.
Engajar melhor os públicos
Com uma navegação mais intuitiva, o público que consome a documentação fica mais engajado a continuar consumindo e contribuindo para a evolução do conteúdo e, consequentemente, do produto em si. Ou seja, isso faz com que a documentação alcance seu objetivo: facilitar a vida do público-alvo, e não dificultar.
Diminuir custos
Cada plataforma possui um custo de manutenção. Centralizando a informação, é possível diminuir o número de plataformas utilizadas e o custo suportado pela empresa para a manutenção de várias ferramentas.
Com esses benefícios em mente, não há dúvidas de que o SSoT pode, realmente, virar a chave de um projeto no tópico de documentação. Basta a coragem e a iniciativa de iniciar a implementação, que os resultados certamente farão todo o trabalho valer a pena.
Implementação no projeto
Em um primeiro momento as dores devem ser mapeadas por nível de prioridade, que deve ser definido pelo time de TWs, em conjunto com a liderança do projeto. Com essa definição, a ferramenta de centralização é escolhida e a documentação passa a ser centralizada.
O SSoT é um modelo para funcionar a longo prazo. Isso significa que os primeiros resultados após a implementação devem surgir em alguns meses. Além disso, deve-se ter em mente o fato de que essa unificação não funciona sozinha, são necessárias diversas ações de acompanhamento dos resultados.
Portanto, é essencial que a verificação desses resultados seja realizada de forma periódica, pelas pessoas que estão envolvidas na centralização e por aquelas que têm o domínio daquele conteúdo. Dessa forma, podem mapear as necessidades de melhorias estratégicas e verificar se a implementação atingiu o propósito estabelecido.
Isso pode ser feito através dos feedbacks, acompanhamento do histórico de utilização, modificações em números de chamados, entrevistas com pessoas usuárias ou qualquer outro meio que se mostrar viável para a realidade do projeto.
Conclusão
Você deve ter percebido como é primordial centralizar as informações para ter um trabalho mais otimizado e que o Single Source of Truth pode ajudar nisso.
A gestão de conteúdos facilita na luta diária contra informações duplicadas, desatualizadas e descentralizadas, colocando em um único local tudo que é importante ter conhecimento.
Vale lembrar que não existe mágica! A implementação e todos os seus benefícios não são de um dia pra noite, os times precisam trabalhar juntos para fazer o Single Source of Truth funcionar da melhor maneira, com direito à feedbacks e muita comunicação.
Agora, me conte: conhece ou fez parte de algum case de sucesso de implementação do SSoT? Deixe sua experiência nos comentários!
Referências
- Building a true Single Source of Truth (SSoT) for your team – Atlassian
- DocOps – Comunidade Write de Docs
- DocOps: Interview with Jim Turcotte – I’d Rather Be Writing
- Implementing single source of truth in an enterprise architecture – Red Hat
- Single Source of Truth: O que é isso? – Salesforce blog
