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:
- 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 (3 meses)
Project description
Buscamos reformular e aprimorar a documentação do OpenELIS voltada ao usuário. A I-TECH pretende revolucionar a maneira como os usuários do OpenELIS obtêm ajuda com base nas necessidades específicas do contexto. Atualmente, as instruções sobre como usar o OpenELIS estão contidas em um único manual que os usuários podem achar tedioso e demorado para navegar. Alguns usuários, principalmente os novos, gostam de ter acesso a uma ampla variedade de materiais nos quais podem navegar e aprender ao longo do caminho. Outros usuários, especialmente aqueles mais experientes e familiarizados com um produto digital específico, como o OpenELIS, desejarão localizar e usar rapidamente um recurso específico para concluir uma tarefa de entrada de dados ou relatório. Confira algumas atividades específicas:
converter o Manual do Usuário atual (desatualizado) em uma biblioteca abrangente e atualizada de auxílios ao trabalho e tutoriais escritos 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
Fornecer aos usuários acesso a uma lista "Top 10" dos recursos de ajuda mais acessados.
Criar um guia de estilo e um documento de convenções de codificação