Esta página contém os detalhes de um projeto de escrita técnica aceito para o Temporada dos Documentos Google.
Resumo do projeto
- Organização de código aberto:
- Principal
- Redator técnico:
- @anindita_basu
- Nome do projeto:
- Revisar e refinar o texto do produto
- Duração do projeto:
- Longa duração (cinco meses)
Project description
Entrei no canal do Slack e fiz algumas perguntas a Eric. Com base
na resposta dele (obrigado, Eric!), Proponho uma abordagem a este projeto
da seguinte maneira:
Classificar as strings
Começarei identificando quais das strings (https://github.com/mattermost/mattermost-webapp/blob/master/i18n/en.json) são as strings do console do sistema e quais são voltadas para o usuário. Proponho analisar primeiro as strings voltadas ao usuário.
Criar um guia de estilo para as strings
Gostaria de 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 (veja 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.
O objetivo é manter essa orientação em uma página de tamanho A4, mais curta, se possível. A intenção é que os desenvolvedores que realmente escrevem essas strings encontrem a orientação rápida e fácil de usar e, quando seguida, o texto da IU 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 GSoD terminar, haja um conjunto de instruções que qualquer pessoa possa consultar rapidamente ao escrever texto de interface
Revisar e refinar o texto
Com base no guia de estilo criado na etapa 2, vou editar as strings e criar solicitações de envio no GitHub.
=============
Duração
Ainda não sei quantas das strings são voltadas ao usuário (o que pretendo analisar neste projeto). Eu estimo que a criação do guia de estilo levará 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 do usuário. Proponho começar com a suposição de que o projeto será de duração padrão (três meses), em que coloco o máximo de strings para revisão possível dentro desse prazo.
Como já trabalho em tempo integral, só posso trabalhar parte do dia nesse projeto. Estou aberto à possibilidade de um projeto de maior duração se você achar que minha redução do horário de trabalho vai precisar disso.