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:
- Kaleidoscope
- Redator técnico:
- techwriterjill (link em inglês)
- Nome do projeto:
- Desenvolver e melhorar a documentação do Kaleidoscope
- Duração do projeto:
- Duração padrão (3 meses)
Project description
Como escritor, tenho muito interesse neste projeto. Atualmente, uso um teclado ergonômico que não tem os recursos do Kaleidoscope Model 01, mas minha familiaridade com um layout de teclado dividido/com suportes me ajudará nas fases iniciais ao testar e explorar as funções do firmware. Minha experiência como usuário de produtos semelhantes também vai me ajudar a identificar os recursos e a documentação do produto que outros usuários consideram úteis.
Tenho experiência em documentar a instalação e configuração de produtos complexos e gosto muito desse tipo de trabalho. Também gosto de ter uma "prática prática" (o que será bastante literal neste caso) com produtos e processos para me familiarizar com eles e escrever sobre eles. Isso me permite produzir documentação de qualidade que tem valor real para os usuários.
Antes de me tornar redatora técnica, trabalhei como analista de suporte, o que me deu habilidades valiosas que eu usaria neste projeto, como compilar código, testar, investigar e replicar problemas.
Fiz o contato inicial com Jesse e Gergely da Kaleidoscope e elaboramos um plano tentativo que, se aceito, me permitiria trabalhar nos seguintes projetos, que eles identificaram como os mais valiosos para os usuários:
- Documentar os plug-ins de hardware
- Documentar como escrever macros para o usuário iniciante
- Escreva uma visão geral dos plug-ins disponíveis
Eu trabalho em tempo integral, então posso me comprometer com cerca de 10 horas por semana durante o período da Temporada dos Documentos. Isso pode me permitir concluir mais projetos pequenos além dos mencionados acima. Ao pesquisar a Kaleidoscope, notei que a única descrição fácil de usar do produto está na página do Kickstarter. O projeto inicial de crowdfunding terminou em 2015, então acho que um site focado no usuário é necessário. Não sou desenvolvedor da Web, mas ficaria feliz em contribuir com ideias e textos para o site, se isso for do interesse da Kaleidoscope.
Jesse e Gergely se ofereceram para enviar um teclado para o escritor de sucesso, e acho que isso será fundamental para o sucesso do projeto.
Acredito que minhas habilidades e experiência me tornam o candidato ideal para este projeto. Aguardo seu contato.