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:
- Mais importante
- Redator técnico:
- @anindita_basu
- Nome do projeto:
- Revise e refine o texto no produto
- Duração do projeto:
- De longa duração (5 meses)
Project description
Entrei no canal do Slack e fiz algumas perguntas para o Eric. Com base
na resposta dele (obrigado, Eric!), Proponho abordar este projeto
da seguinte maneira:
classificar as strings
Começaremos identificando quais das strings (https://github.com/mattermost/mattermost-webapp/blob/master/i18n/en.json) são as do console do sistema e quais são voltadas para o usuário. Sugiro começar a usar as strings voltadas para o usuário para análise.
Criar um guia de estilo para as strings
Quero definir o estilo de letras maiúsculas, comprimento e uso de palavras para strings usadas em itens de menu, botões de ação, rótulos, cabeçalhos, dicas, erros, avisos, validações, notificações e confirmações (consulte um exemplo de captura de tela do guia de estilo em https://github.com/AninditaBasu/AninditaBasu.github.io/blob/master/gsod/Capture7.PNG). Além disso, gostaria de criar algumas orientações sobre o uso de tokens (marcadores de posição) em strings, especialmente strings compostas.
Pretendo manter esta orientação em uma página de uma folha de tamanho A4, menor se possível. A intenção é que os desenvolvedores que realmente escrevem essas strings considerem a orientação rápida e fácil de usar. Além disso, quando seguida, o texto da interface vai mostrar consistência em todas as telas.
Proponho fazer isso por dois motivos: (a) para que haja consistência no texto em termos de gramática e estilo (b) para que, mesmo após o fim do GSoD, haja um conjunto de instruções que qualquer pessoa possa consultar rapidamente ao escrever o texto da interface.
Revisar e refinar o texto
Com base no guia de estilo criado na segunda etapa, editarei as strings e criarei solicitações de envio no GitHub.
=============
Duração
Ainda não sei quantas das strings são strings voltadas para o usuário (que é o que proponho para análise neste projeto). Estimamos que a criação do guia de estilo levaria cerca de três semanas (do rascunho à aprovação), e esse trabalho pode ser feito simultaneamente com a categorização de strings como strings do sistema ou voltadas para o usuário. Proponho começar com o pressuposto de que o projeto terá duração padrão (três meses), em que peço apenas o máximo possível de strings para revisão dentro desse prazo.
Como já estou empregado em tempo integral, poderia trabalhar apenas parte do dia neste projeto. Estou aberto à possibilidade de um projeto de maior duração se você achar que meu horário de trabalho reduzido precisará dele.