Esta página contém os detalhes de um projeto de escrita técnica aceito para a temporada de documentos do Google.
Resumo do projeto
- Organização de código aberto:
- Fundação Geospatial de código aberto
- Redator técnico:
- flicstar
- Nome do projeto:
- Revise os guias de início rápido do OSGeoLive
- Duração do projeto:
- Duração padrão (3 meses)
Project description
Finalidade
- Atualize os documentos para mantê-los atualizados, precisos e relevantes.
- Crie um modelo para garantir a consistência entre os documentos e para futuros guias de início rápido adicionados.
Público-alvo
- Novos usuários do OSGeo ao vivo
- Editores dos novos guias de início rápido do OSGeo Live
Entrega
- Wiki
Acho que isso precisa ser feito:
- Executar os 50 guias de início rápido do OSGeo Live
- Marcar com edições. Enviar para revisão.
- Implementar a revisão/feedback
- Criar um modelo de guia de início rápido para implementar consistência no futuro
- Atualize o "Como fazer um procedimento de início rápido".
- Adicionar novos apps ao OSGeoLive. Eles precisam de guias de início rápido.
O que eu proponho a fazer:
Revise os 50 guias de início rápido do OSGeo Live e faça marcações com edições usando estas páginas como referência:
Novo: https://trac.osgeo.org/osgeolive/wiki/How%20to%20document%20the%20quickstart%20file
Antigo: https://wiki.osgeo.org/wiki/OSGeoLive_AddProject#Documentation
Criação de problemas de documentação no tráfego (Issue Tracker)
Forneça um relatório com um resumo do resultado. Por exemplo, uma porcentagem dos 50 que exigem pouco, médio ou muito trabalho.
Criar um modelo de início rápido para implementar consistência no futuro
Atualize a página "Como documentar o arquivo de início rápido".
O que você vai ter ao final da SoD:
- 50 tíquetes de documentação no Trac, com guias de início rápido marcados de acordo com o modelo acordado
- Um resumo do status atual dos guias de início rápido do OSGeo Live e da quantidade de trabalho necessária para atualizá-los.
- Um modelo atualizado do guia de início rápido consistente com o modelo do Guia de treinamento
- Um processo atualizado da documentação do guia de início rápido.
Por onde começar:
- Consulte a planilha de pacotes OSGeo-Live para ver quais pacotes mudaram entre as versões.
- Pergunte se a lista de e-mails do OSGEo Live tem sugestões de guias de início rápido específicos para começar.
O que já fiz:
- Configurar a VM e o OSGeoLive instalado
- Bifurcou o repositório OSGeoLive-Doc
- Ganhou acesso ao Trac e analisou alguns tíquetes de documentos existentes. O ingresso 1382 parece relevante: https://trac.osgeo.org/osgeolive/ticket/1382
- Participação em discussões em listas de e-mails
- Tive alguns chats por vídeo informais