Modelo de estudo de caso da temporada de documentos do Google

Fase atual:
resultados anunciados. Consulte linha do tempo.

Use estes modelos de títulos 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 sua organização no Google Season of Docs)

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

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

Declaraçã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 da organização. Link para a página da proposta no site do seu projeto, se possível.

Descrição do projeto

Como criar a proposta

Como você criou sua proposta para a Temporada de documentos do Google? Qual processo sua organização usou para decidir sobre uma ideia? Como você pediu e incorporou o feedback?

Orçamento

Incluir uma breve seção no orçamento. Como você fez a estimativa do trabalho? Houve despesas inesperadas? Você gastou menos do que o prêmio concedido? Você alocou os fundos corretamente ou alguns itens orçados foram a mais/menos/desnecessários? Você tinha recursos financeiros fora do Google Docs que conseguiu usar?

Participantes

Quem trabalhou no projeto (usar 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? Quais foram os papéis deles? Alguém desistiu? O que você aprendeu sobre recrutamento, comunicação e gerenciamento de projetos?

Cronograma

Faça um breve resumo do cronograma do seu projeto (indique a data de término estimada ou marcos intermediários se o projeto estiver em andamento).O cronograma original precisou de ajustes?

Resultados

O que foi criado, atualizado ou alterado? Inclua links para a documentação publicada, se disponível. Houve algum resultado na proposta que não foi criado? Liste-os também. Esse projeto resultou em processos ou procedimentos novos ou atualizados na sua organização?

Métricas

Quais métricas você escolheu para medir o sucesso do projeto? Você conseguiu coletar essas métricas? As métricas se correlacionam bem ou mal com os comportamentos ou resultados que você queria para o projeto? Suas métricas mudaram desde a proposta? Você adicionou ou removeu alguma métrica? Com que frequência você pretende coletar métricas no futuro?

Análise

O que deu certo? O que foi inesperado? Quais obstáculos ou contratempos você enfrentou? Você considera seu projeto um sucesso? Por que sim ou por que não? (Se for muito cedo para dizer, explique quando você espera poder 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 faria de forma diferente no futuro. Que conselho você daria a outros projetos que tentam resolver um problema semelhante com a documentação?

Apêndice

Se você tiver outros materiais que gostaria de vincular (por exemplo, se você criou um contrato para trabalhar com seu redator técnico que gostaria de compartilhar, ou modelos para seu projeto de documentação ou outros recursos de documentação abertos, você pode listar e vincular aqui). O apêndice também é um bom lugar para listar links para ferramentas ou recursos de documentação que você usou ou para adicionar agradecimentos ou reconhecimentos que não se encaixam nas seções acima.