Esta página contém os detalhes de um projeto de redação técnica aceito para a Google Season of Docs.
Resumo do projeto
- Organização de código aberto:
- OpenELIS Global
- Redator técnico:
- Areesha
- Nome do projeto:
- Documentação do OpenELIS para usuários finais
- Duração do projeto:
- Duração padrão (três meses)
Project description
Nosso objetivo é redesenhar e aprimorar a documentação voltada ao usuário do OpenELIS. A I-TECH pretende revolucionar a maneira como os usuários do OpenELIS recebem ajuda com base nas necessidades específicas do contexto. Atualmente, as instruções sobre o uso do OpenELIS estão contidas em um único manual do usuário, que pode ser tedioso e demorado para navegar. Alguns usuários, principalmente os novos, gostam de ter acesso a uma ampla variedade de materiais que podem ser visualizados e aprendidos ao longo do caminho. Outros usuários, especialmente aqueles que têm mais experiência e conhecem um produto digital específico, como o OpenELIS, vão querer localizar e usar rapidamente um recurso específico para concluir uma tarefa de entrada de dados ou geração de relatórios. As atividades específicas incluem:
Converter o Manual do Usuário existente (desatualizado) em uma biblioteca abrangente e atualizada de ajuda para tarefas e tutoriais por escrito sobre todas as funcionalidades atuais (incluindo funcionalidades mais recentes, como gerenciamento de testes, leitura de código de barras, entrada em lote e importação de resultados do analisador), incluindo tags de metadados para ajudar a indexar as informações;
Desenvolver / atualizar uma versão em inglês dos materiais de ajuda
Oferecer aos usuários acesso a uma lista dos 10 recursos de trabalho mais acessados.
Criar um guia de estilo e um documento de convenções de codificação