<Org Name>: <Year> Google Season of Docs Case Study
Nome da organização ou do projeto:
Link da Season of Docs:
Descrição da organização: de uma a duas frases que dão uma breve visão geral do que sua organização ou projeto faz.
Autores: listar os autores do estudo de caso; usar nomes de usuário, se solicitado (opcional)
Resumo
Preencha a tabela a seguir e responda às perguntas de forma breve. Você pode fornecer mais detalhes em seções posteriores. Recomendamos que você escreva as seções detalhadas primeiro e depois volte para escrever o resumo.
| # Redatores técnicos | Horas de projeto TW | Orçamento | % do projeto concluído |
|---|---|---|---|
| ## | ## | US$ X | X% |
Qual problema você estava tentando resolver? E como você tentou resolver?
Quais foram os resultados do seu projeto?
O que deu certo? E o que você faria de diferente?
Qual conselho você daria a outros projetos que tentam resolver um problema semelhante com a documentação?
Descrição do projeto
Descreva o projeto preenchendo as seções a seguir.
Proposta de projeto
Forneça um breve resumo da proposta e um link para a página da proposta no site do projeto.
Processo de criação de propostas
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ê solicitou e incorporou feedback? Quem participou do processo? Quanto tempo levou?
Orçamento
Responda às perguntas na tabela a seguir.
| Quanto dinheiro você pediu? | |
| Como você chegou a essa estimativa? | |
| Quantas horas de trabalho você estimou para o projeto? | |
| Quantas horas de trabalho foram necessárias para o projeto? | |
| Quais outras despesas você incluiu no seu orçamento? | |
| Você teve surpresas de orçamento durante o projeto (por exemplo, estimativas incorretas)? Em caso afirmativo, explique o que. |
Recrutamento de redatores técnicos
Como você encontrou e contratou seu redator técnico? O processo funcionou bem? Eles ficaram durante todo o projeto?
Outros participantes
Quem mais trabalhou neste projeto (use nomes de usuário se solicitado pelos participantes)? Como você recrutou essas pessoas? Quais funções eles tinham? Eles permaneceram durante toda a duração do projeto?
Cronograma
Faça uma breve descrição da linha do tempo do seu projeto (indique a data de término estimada ou marcos intermediários se o projeto estiver em andamento). A linha do tempo original precisa de ajustes?
Resultados
Preencha as tabelas a seguir para descrever o que foi criado, atualizado ou alterado durante o projeto. Inclua entregas planejadas e não planejadas. Inclua as coisas que foram planejadas, mas não concluídas.
Resultados esperados
Os links relevantes podem incluir documentos publicados, solicitações de pull ou outros artefatos.
| Resultado | % concluído | Links relevantes | Observações |
|---|---|---|---|
| Entrega 1 | |||
| … | |||
| Resultado final #N |
Entregas não planejadas
Foram criados resultados que não foram planejados no início do projeto? Em caso afirmativo, explique.
Métricas
Quais métricas você escolheu para medir o sucesso do projeto? Você conseguiu coletar essas métricas? Você notou alguma mudança como resultado do projeto? Você adicionou ou removeu alguma métrica desde a proposta? Com que frequência você pretende coletar métricas daqui para frente?
Análise
Forneça uma breve narrativa sobre como o projeto foi realizado. O projeto foi bem-sucedido? Por que sim ou por que não? Ou quando você poderá julgar o sucesso? Você encontrou obstáculos ou contratempos inesperados? O projeto resultou em processos ou procedimentos novos ou atualizados na sua organização?
Lições aprendidas
Use as tabelas a seguir para destacar as lições aprendidas, o que deu certo e o que poderia ser melhorado. Use as categorias de tópicos listadas ou adicione as suas. Você pode ter várias linhas para um determinado tópico, conforme necessário. Essas lições aprendidas vão alimentar nossa lista agregada de práticas recomendadas para projetos de documentação.
O que deu certo?
Para as lições aprendidas, adicione as suas ou indique uma "aprovação" para qualquer uma das práticas recomendadas da Temporada de Documentos do Google.
| Tópico | O que nós fizemos | Lição aprendida |
|---|---|---|
| Orçamento | ||
| Comunicação | ||
| Orientação individual | ||
| Métricas | ||
| Integração | ||
| Participantes | ||
| Resultados do projeto | ||
| Gerenciamento de projetos | ||
| Recrutamento e contratação | ||
| … | ||
| <Outros tópicos, conforme necessário> | ||
O que pode ser melhorado?
Para as lições aprendidas, adicione as suas ou indique uma "aprovação" para qualquer uma das práticas recomendadas da Temporada de Documentos do Google.
| Tópico | O que nós fizemos | O que faríamos de forma diferente | Lição aprendida |
|---|---|---|---|
| Orçamento | |||
| Comunicação | |||
| Orientação individual | |||
| Métricas | |||
| Integração | |||
| Participantes | |||
| Resultados do projeto | |||
| Gerenciamento de projetos | |||
| Recrutamento e contratação | |||
| … | |||
| <Outros tópicos, conforme necessário> | |||
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 anteriores.