Para manter a competitividade nos negócios, agilidade é essencial.
Equipes de desenvolvimento de software migraram para as metodologias de desenvolvimento Ágil e DevOps.
Mas suas documentações se mantiveram na Idade das Pedras. Ainda em cascata, sendo uma etapa a ser entregue no final (e muitas vezes já nasce desatualizada) e quase sempre, somado a isto, elas sofrem da síndrome ROT.
Síndrome do Conteúdo ROT - Redundant, Outdated and Trivial
Com Agilidade, não há tempo para a pausa e realizar a ‘transferência’ do conhecimento para uma documentação que não entrou na mudança cultural. Não há colaboração, integração e entrega contínua neste ponto.
O DocOps trata do estabelecimento de documentação contínua para tornar o DevOps (entrega contínua) bem-sucedido.
Isso exigirá a integração de departamentos e usuários de equipes interdisciplinares no processo de criação de documentos. Idealmente, uma nova função de ‘Gerente de Informações’ deve:
-
Ser responsável por todos os requisitos de documentos.
-
Controlar a criação e manutenção de informações.
-
Disponibilizar informações por meio de um portal padronizado.
O DocOps trata da criação de uma cadeia de suprimentos de conteúdo que seja colaborativa, ágil e contínua em sua essência.
Com o DocOps é possível zelar, encarregar e tornar-se mais responsável pelo conteúdo de autores internos e externos durante todo o ciclo de vida do produto.
O conteúdo é então publicado usando uma plataforma que fornece uma única fonte de conteúdo contextualmente vinculada às interfaces do produto.
E permite que a empresa obtenha feedback operacional contínuo e faça alterações em tempo real para melhorar a experiência do cliente.
Alguns princípios-chave por trás do que o DocOps faz:
-
Cria um fluxo contínuo de documentação técnica, semelhante ao modo como a integração contínua cria um fluxo contínuo para desenvolvedores de software.
-
Move todos os documentos para uma plataforma colaborativa baseada em nuvem, como um wiki, que se torna a principal plataforma de publicação e entrega de documentação do usuário.
-
Alinha ferramentas Ágeis comuns com uma plataforma de publicação de documentação.
O DocOps pede para aplicar análises e relatórios para monitorar qual conteúdo está tendo um desempenho melhor do que outros.
À medida que o gerenciamento e a empresa se tornam mais orientados por dados, permite o gerenciamento melhor do conteúdo e concentra seus esforços de desenvolvimento no conteúdo que os leitores precisam em relação ao o que a equipe de documentação percebe como necessidades dos leitores.
O DocOps é essencial para permitir agilidade nos negócios!
DocOps - How CA Technologies Got Started! - https://www.linkedin.com/pulse/20140911020510-10335988-the-ca-technologies-docops-platform-phase-1/
Case da CA Technologies:
-
+300 Devs
-
+24.000 Documentos (de 100 a 1000 páginas cada)
-
+300 produtos
-
19 idiomas
Ferramentas utilizadas: Atlassian + Appfusions + Lingotek
https://lingotek.com/images/pdf/Lingotek_Case_Study_CA_04_11_12.pdf
Outros exemplos:
Muitas empresas utilizam a plataforma https://readme.io
O pessoal da Stripe utiliza a plataforma https://markdoc.dev, desenvolvida por eles mesmos e disponibilizada open source.
E aqui onde este blog está hospedado (hashnode) há o recurso de docs, para documentação de APIs e produtos.
Outros textos a respeito de documentação:
docs-as-code-documentacao-como-codigo
As documentações do SRE: