Photo by <a href=Markus Spiske / Unsplash">
Photo by Markus Spiske / Unsplash

Como criar uma documentação interna de funcionalidades

Não confie que as pessoas vão lembrar de tudo o que aconteceu


Muito se fala que documentação é uma das principais responsabilidades de um PM e no artigo de hoje mostrarei uma forma de fazer isso quando precisamos criar algo para que outros times da empresa usem, principalmente em setores como atendimento e comercial.

Por que documentar?

Como uma pessoa que não tem costume de ler manuais, essa foi uma das primeiras coisas que pensei quando ouvi que parte do meu trabalho era documentar. Bom, aqui vão alguns porquês que descobri ao longo desses quase dois anos como PM:

  • Sua cabeça não é um lugar confiável para guardar as coisas. Então ter um lugar organizado e centralizado pode te salvar quando você precisa resgatar algo;
  • Facilite a vida dos outros times. Com a documentação criar os tutoriais e wikis que ficarão disponíveis para o cliente fica muito mais fácil;
  • É uma forma de revisar o produto. Ao documentar, principalmente usando recursos como vídeos ou até mesmo gifs, você pode perceber déficits e oportunidades de melhoria na experiência com seu produto;
  • Facilite a sua vida. Como PM, é possível que os times procurem você para tirar dúvidas de como algo funciona. Se você já tiver se antecipado e criado a documentação, é só mandar o link para a pessoa.

Iniciando

O primeiro passo é identificar para quem você está criando a documentação. Mapear as partes interessadas permitirá que você coloque o que de fato é relevante, afinal, consultar documentação tende a não ser uma tarefa das mais divertidas.

Esse conteúdo é para pessoas inscritas no portal

A inscrição é gratuita e te dá direito a ter nossa newsletter às quartas e os conteúdos abertos no site. Masss você fica sem uma série de outros benefícios gratuitos para assinantes, como a nossa newsletter exclusiva às sextas, nossos eventos e meetups.


Já é inscrito? Você pode entrar aqui.

Você sabia que temos conteúdos exclusivos para assinantes do portal?

Além de ter acesso ilimitado a todos os conteúdos, você também pode participar de palestras exclusivas, sessões de Q&A, mentorias em grupo e acesso à descontos em cursos. E claro, assinando você nos ajuda a manter o projeto e aumentar a nossa produção de conteúdo.

Você pode assinar clicando aqui

Inscreva-se no Product Oversee

Textos todas às quartas 7h45 na sua caixa de entrada.
Inscreva-se grátis