Como criar um estudo de caso

Fase atual:
O programa "Season of Docs" de 2021 terminou em 14 de dezembro de 2021. Consulte a linha do tempo.

Como parte da Temporada de documentos de 2021, as organizações precisam enviar uma avaliação final e um estudo de caso. Use nosso modelo de estudo de caso e exemplo de estudo de caso como guias para criar seu próprio estudo de caso.

O formulário de avaliação final estará disponível pelo menos um mês antes de 30 de novembro de 2021, às 18h (UTC).

Visão geral do estudo de caso

O modelo de estudo de caso vai incluir estas seções:

  • Definição do problema: qual problema você estava tentando resolver com a documentação nova ou melhorada?
  • Resumo da proposta: um breve resumo da proposta original de organização
  • Descrição do projeto: uma descrição narrativa do seu projeto. Incluir:
    • Como você criou sua proposta (e o link para a página original de ideias de projeto).
    • Como você recrutou e selecionou um redator técnico ou outros participantes.
    • Quem trabalhou no projeto (use nomes de usuário se solicitado pelos participantes).
    • Quanto tempo o projeto levou para ser concluído (se concluído).
    • O que deu certo?
    • O que foi inesperado? Quais obstáculos ou contratempos você enfrentou?
    • Qual documentação foi criada, atualizada, aprimorada ou removida?
  • Esse projeto resultou em processos ou procedimentos novos ou atualizados na sua organização?
  • Métricas:
    • Quais métricas foram escolhidas para medir o sucesso do projeto?
    • Você conseguiu coletar essas métricas?
    • Eles estão relacionados aos comportamentos ou parâmetros esperados?
    • As métricas escolhidas mudaram? Você removeu ou adicionou alguma métrica?
    • De acordo com suas métricas, seu projeto é bem-sucedido? (Ainda é precoce para saber.)
    • Com que frequência você pretende coletar métricas no futuro?
  • Resumo:
    • Em dois a quatro parágrafos, resuma sua experiência no projeto. O que você aprendeu? O que você faria de diferente no futuro? Que conselho você daria a projetos que tentam resolver um problema semelhante com a documentação?

Orientações sobre o estudo de caso

  • Manter um registro semanal das atualizações do projeto vai ajudar você a criar seu estudo de caso. Para cada semana, registre o progresso do projeto (incluindo links para solicitações de pull, problemas ou conversas, quando útil), o que foi bem (ou não), o que você aprendeu e as perguntas que foram feitas.
  • Ao escrever seu estudo de caso, seja gentil. Evite culpar e mantenha a conversa construtiva. Lembre-se de que estudos de caso são públicos.
  • Use o mesmo tom no seu estudo de caso que você usaria para uma postagem de blog ou um tutorial. Não seja excessivamente formal.