Modelo de estudo de caso da temporada dos Documentos Google

Fase atual:
a temporada de 2021 do programa Documentos foi encerrada em 14 de dezembro de 2021. Consulte o cronograma.

Use estes títulos de modelo para criar seu próprio relatório de estudo de caso.

Título

Organização ou projeto: nome da organização (link para a página ou o site da temporada de documentos da sua organização)

Descrição da organização: um pitch rápido que apresenta uma breve visão geral do que sua organização ou projeto faz

Autores: opcional: liste os autores do estudo de caso e use nomes de usuário se solicitado

Declaração do problema

Qual problema você estava tentando resolver com uma documentação nova ou aprimorada?

Resumo da proposta

Um breve resumo da sua proposta de organização original. Link para a página da proposta no site do projeto, se possível.

Descrição do projeto

Criar a proposta

Como você elaborou sua proposta para a temporada dos Documentos Google? Qual processo sua organização usou para decidir sobre uma ideia? Como você solicitou e incorporou feedback?

Orçamento

Inclua uma pequena seção sobre seu orçamento. Como você estimou o trabalho? Houve alguma despesa inesperada? Você gastou menos do que o prêmio? Você tinha outros fundos fora da Season of Docs que conseguiu usar?

Participantes

Quem trabalhou no projeto (use nomes de usuário se solicitado pelos participantes)? Como você encontrou e contratou seu redator técnico? Como você encontrou outros voluntários ou participantes pagos? Que funções eles tinham? Alguém saiu? O que você aprendeu sobre recrutamento, comunicação e gerenciamento de projetos?

Cronograma

Apresente uma breve visão geral do cronograma do seu projeto (indique a data de término estimada ou marcos intermediários se o projeto estiver em andamento).

Resultados

O que foi criado, atualizado ou alterado? Inclua links para a documentação publicada, se disponíveis. Houve alguma entrega na proposta que não foi criada? Liste-os também.

Métricas

Quais métricas você escolheu para medir o sucesso do projeto? Você conseguiu coletar essas métricas? As métricas se correlacionaram bem ou mal com os resultados que você queria para o projeto? Suas métricas mudaram desde a proposta?

Análise

O que deu certo? O que foi inesperado? Quais obstáculos ou contratempos você enfrentou? Você considera seu projeto bem-sucedido? Por quê? Se for muito cedo para dizer, explique quando você espera ser capaz de julgar o sucesso do seu projeto.

Resumo

Em dois a quatro parágrafos, resuma sua experiência com o projeto. Destaque o que você aprendeu e o que escolheria fazer diferente no futuro. Que conselho você daria para outros projetos que estão tentando resolver um problema semelhante com a documentação?

Apêndice

Se quiser criar um link para outros materiais, por exemplo, se você criou um contrato para trabalhar com seu redator técnico e gostaria de compartilhar, modelos para seu projeto de documentação ou outros recursos de documentação abertos, liste-os aqui. O Apêndice também é um bom lugar para listar links para ferramentas ou recursos de documentação que você usou, ou um local para adicionar agradecimentos ou agradecimentos que não se encaixam nas seções acima.