Fase atual:
a temporada de documentos de 2021 terminou em 14 de dezembro de 2021. Consulte a
linha do tempo.
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 o site ou a página da temporada de documentos da sua organização)
Descrição da organização: um argumento rápido de venda que fornece 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 uma documentação nova ou aprimorada?
Resumo da proposta
Um breve resumo da sua proposta de organização original. Adicione um link para a página da proposta no site do seu projeto, se possível.
Descrição do projeto
Criação da proposta
Como você elaborou sua proposta para a temporada de Documentos? Qual processo sua organização usou para tomar uma decisão 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 do subsídio? Você tinha outros fundos fora da temporada de documentos que poderia usar?
Participantes
Quem trabalhou neste projeto (use nomes de usuário se os participantes pedirem)? 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
Dê uma breve visão geral do cronograma do 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? Que 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. Qual conselho você daria a outros projetos que tentam resolver um problema semelhante com a documentação?
Apêndice
Se você tiver outros materiais que queira incluir no link, por exemplo, caso tenha criado um contrato de trabalho com seu redator técnico que gostaria de compartilhar, modelos para seu projeto de documentação ou outros recursos de documentação abertos, liste e vincule aqui. O Apêndice também é um bom lugar para listar links para ferramentas ou recursos de documentação que você usou ou um lugar para agradecer ou agradecer que não se encaixa nas seções acima.