3 razões para hospedar um docathon para seu projeto de código aberto

A documentação do seu projeto de código aberto é essencial para seus clientes. Seu público-alvo deve entender o propósito do seu projeto e como usá-lo, e a documentação é o que preenche essa lacuna. Um projeto raramente é realmente concluído, por isso é igualmente importante que os recursos sejam mantidos e atualizados com a melhoria contínua do seu projeto.

Mas o que acontece quando você tem muita documentação para manter, mas não tem recursos para mantê-la atualizada? A resposta é bem simples: organize um docathon!

O que é um docaton?

Um docathon é como um hackathon. Um hackathon é um evento onde engenheiros e líderes comunitários se reúnem para melhorar ou adicionar novos recursos a um aplicativo existente. Num docathon, o mesmo tipo de colaboração centra-se na melhoria da documentação.

(Aprenda como escrever documentos como código.)

Um docathon pode preencher lacunas no conteúdo, reestruturar grandes conjuntos de documentação, consertar links quebrados ou apenas corrigir erros de digitação. A intenção por trás de hospedar um docathon é melhorar uma grande quantidade de documentação em um período de tempo relativamente curto.

Alguns exemplos de documentação do produto incluem:

• Manuais de treinamento
• Manuais do usuário
• Guias de instalação
• Guias de solução de problemas
• Guias de início rápido
• API documentação
• Tutoriais

Na minha organização, nossa equipe de documentação organizou um docathon e renovou com sucesso um guia de instalação de 102 páginas. O docathon nos permitiu focar no escopo do projeto, que era reorganizar para simplificar, remover conteúdo duplicado e acompanhar a jornada do cliente. Organizar um docathon deixou uma impressão duradoura em minha equipe e melhorou o sucesso do cliente.

(Leia e escreva a documentação que realmente funciona para sua comunidade)

3 coisas que você pode alcançar com um docathon

Aqui estão meus três principais motivos para hospedar um docathon:

1. Chega de atrasos

A maior parte da documentação deve evoluir junto com o produto que suporta. À medida que o produto muda ou é atualizado, a documentação também deve. Em alguns casos, as equipes de documentação lançam novas versões de sua documentação junto com o ciclo de lançamento da equipe de engenharia. À medida que as prioridades dentro de uma equipe mudam e os lançamentos do GA continuam, as equipes de documentação enfrentam o desafio de acompanhar novos recursos, correções de bugs e tarefas a serem concluídas. As mudanças deixadas para trás tornam-se parte de um backlog – um acúmulo de trabalho que precisa ser concluído posteriormente.

Tipo Docaton: Durante um docathon, os participantes podem fazer a triagem dos itens do backlog e concluí-los à medida que avançam na lista. Os participantes não técnicos podem trabalhar em correções relacionadas a erros de digitação, links quebrados e outros problemas relacionados ao texto.

2. Renovar guias em grande escala

Quando sua equipe de documentação percebe que é hora de reformular um guia, ele provavelmente já contém vários capítulos e centenas de páginas. Uma vez desenvolvido o plano de conteúdo, começa a complexidade da reestruturação. A reestruturação de uma grande quantidade de documentação não é para os fracos de coração.

Tipo Docaton: Monte uma equipe para liderar a docatona e forneça incentivos para a participação de diferentes equipes ou departamentos em toda a organização. Dependendo do escopo do trabalho e das restrições de tempo, sua equipe pode reestruturar com êxito um guia inteiro em menos tempo do que você provavelmente espera.

3. Colaboração entre equipes multifuncionais

É comum que diferentes grupos dentro de uma organização trabalhem isoladamente. As equipes de engenharia, produto, suporte ao cliente, marketing e documentação podem não colaborar nos projetos com a frequência que deveriam.

Imagine organizar um evento onde cada membro da equipe possa usar seus conhecimentos para melhorar a documentação do produto. Docathons promovem diversidade de especialistas no assunto (SME), colaboração em tempo real e comunicação. Também permitem um ambiente inclusivo onde indivíduos residentes em diferentes localizações geográficas podem participar pessoalmente ou remotamente. Sua documentação recebe toda a atenção de especialistas com diferentes pontos de vista e especializações, minimizando silos isolados, preconceitos inconscientes e esgotamento.

Tipo Docaton: Permita que equipes multifuncionais se unam por uma causa comum.

(Aprenda o que é preciso para construir uma cultura de TI resiliente )

Maratona de documentação

Na próxima vez que sua equipe tiver um backlog aparentemente intransponível ou for encarregada de reestruturar um enorme projeto de documentação, considere organizar um docathon. É fácil e sua produtividade pode surpreendê-lo. Para obter mais informações sobre como hospedar um evento como este, leia o excelente guia de 10 etapas de Tiffany Long para hospedar um hackathon.