Por uma documentação de qualidade!

Por uma documentação de qualidade!

Ninguém, com certeza, nunca deve ter pensado que uma documentação de baixa qualidade fosse positiva…, mas até onde isso pode prejudicar? Se um software for de qualidade, mas tiver erros em sua documentação ele pode ser usado na educação? Certamente não, mesmo porque, se o objetivo é o ensino, o cuidado em cada detalhe é, sem dúvida, essencial!
É com essa preocupação que vemos notícias como esta:

O festival de asneiras do “Magalhães”
Há frases mal construídas, outras que começam na segunda pessoa do singular e continuam na terceira (tratam o leitor por tu e por você), expressões absurdas e frases que simplesmente não fazem sentido.
Ortografia, sintaxe e gramática – nas instruções dos jogos do computador portátil Magalhães nada resiste às inovações do “magalhanês”. Há palavras repetidamente mal escritas, outras inventadas, verbos mal conjugados, vírgulas semeadas onde calha, acentos que aparecem onde não devem e não estão onde deviam.

Leia mais sobre o assunto no site Teia.
A documentação interfere diretamente na recepção de um produto. No caso de um software, por exemplo, ela é a comunicação direta com o usuário. Também os artigos merecem cuidado, pois disso depende a boa divulgação de qualquer produto.
Elementar, minha cara, dirão vocês… Mas o que fazer para resolver a situação? Se eu recebo um produto com inadequações, o que posso fazer para resolver isso? Você pode, por exemplo, entrar em contato com a coordenação do projeto responsável e comunicar as falhas. Se ele for um projeto responsável, com certeza sua dica será de grande valia.
O grupo Texto Livre busca justamente ajudar com suporte linguístico à documentação de uma forma geral, principalmente à relacionada aos softwares livres. O que podemos é tentar evitar problemas como os enfrentados com o GCompris, oferecendo nossa colaboração.

Por: Daniervelin Pereira (2010, atualizado em 2016).

Por uma documentação de qualidade! de REALPTL está licenciado com uma Licença Creative Commons – Atribuição 4.0 Internacional.