The role of the technical writer-reviwer in the software documentation: tecnical language translation, manualization and proofreading
DOI:
https://doi.org/10.5902/2763938X85503Keywords:
Software Documentation, Manualization, Retextualization, Technical Writer, ProofreaderAbstract
Considering that the writer-proofreader-technician plays a key role in the creation of technical manuals, acting as a mediator between software developers and the end users of the systems, this article presents an analysis carried out on manuals from three IT companies. This analysis is based on the text revision activities, the retextualization operations and the writing style present in these manuals, all analyzed from the practices of three technology companies. It is concluded that the work of the writer-proofreader-technician does not end with the creation of the manual, and that continuous revision is necessary as the software evolves. The importance of the integration between proofreading and technical writing is emphasized, demonstrating the versatility and broad competencies required in this area.
Downloads
References
BENFICA, Maria Flor de Maio. Retextualização. In: Glossário Ceale: termos de alfabetização, leitura e escrita para alfabetizadores. Belo Horizonte: UFMG/Ceale, 2014, s/p. Disponível em: https://www.ceale.fae.ufmg.br/glossarioceale/verbetes/retextualizacao. Acesso em: 26 mar. 2023.
COELHO, Sueli Maria.; ANTUNES, Leandra Batista. Revisão textual: para além da revisão linguística. SCRIPTA, Belo Horizonte, v. 14, n. 26, p. 205-224, jan./jun. 2010. Disponível em: http://periodicos.pucminas.br/index.php/scripta/article/view/4361/4506.
Acesso em: 04 fev. 2023.
DELL’ISOLA, Regina Lúcia Péret. Retextualização de gêneros escritos. Rio de Janeiro: Lucerna, 2007. Coleção Tópicos em Linguagem.
GALES, Christopher and the Splunk Documentation Team. The Product is Docs Writing Technical Documentation in a Product Development Group, 2020. 293 p. E-Book Kindle. Disponível em: The Product is Docs: Writing Technical Documentation in a Product Development group - Gales, Christopher. Acesso em: 01 ago. 2022.
GALVÃO, Maria Cristiane Barbosa. Manual de Software: facilitando a comunicação empresa-sociedade. Tese (Doutorado). Brasília: Universidade de Brasília, 2003, 129 p. Disponível em: https://repositorio.unb.br/bitstream/10482/30525/5/2003_MariaCristianeBarbosaGalv%C3%A3o.pdf. Acesso em: 01 ago. 2022.
GERSON. Steven M. WritingTthat Works - A Teacher’s Guide to Technical Writing. Johnson County Community College. Desenvolvido e publicado por: Centro Curricular do Kansas. Universidade Washburn, Topeka, KS. 2004. Disponível em: https://www.academia.edu/35391096/A_Teachers_Guide_to_Technical_Writing. Acesso em: 11 nov. 2022.
HURWITZ, Judith. Service Virtualization For Dummies. 2nd IBM Limited Edition. Published by. John Wiley & Sons, Inc. 2017. Disponível em: https://www.ibm.com/downloads/cas/5WK0BQ1R. Acesso em: 11 jul. 2023.
MARCUSCHI, Luiz Antônio. Da fala para a escrita: atividades de retextualização. 2. ed. São Paulo: Cortez. 133p, 2001.
MARIA COELHO, Sueli.; BATISTA ANTUNES, L. Revisão textual: para além da revisão linguística. Scripta, v. 14, n. 26, p. 205-224, 27 jul. 2010. Disponível em: http://periodicos.pucminas.br/index.php/scripta/article/view/4361. Acesso em: 04 mar. 2023.
MANTENCIO, Maria de Lourdes M. Retextualização de textos acadêmicos: leitura, produção de textos e construção de conhecimentos. Projeto de Pesquisa/Fapemig. Belo Horizonte: PUC Minas, 2001. p.109-122.
MATENCIO. Maria de Lourdes M. Atividades de (re) textualização em práticas acadêmicas: um estudo do resumo. Scripta - Revista do programa de pós-graduação em LETRAS e do Centro de Estudos Luso-Afro-brasileiros da PUC-MINAS. Belo Horizonte, Scripta v. 6, n.11, p.109-122, 2002. Disponível em: http://periodicos.pucminas.br/index.php/scripta/article/view/12453. Acesso em: 12 mar. 2022.
OLIVEIRA, Maria Carmen de. A retextualização de texto do gênero infográfico: uma análise da estrutura retórica. Orientador: Maria Beatriz Nascimento Decat. 2010. 117 f. Dissertação (Mestrado em Estudos Linguísticos) - Faculdade de Letras da Universidade Federal de Minas Gerais. Belo Horizonte, 2010. Disponível em: http://livros01.livrosgratis.com.br/cp147926.pdf. Acesso em: 28 mar. 2023.
OLIVEIRA, Risoleide Rosa Freire de. Um olhar dialógico sobre a atividade de revisão de textos escritos: entrelaçando dizeres e afazeres. Orientador: Maria Bernadete Fernandes de Oliveira. 2007.172 f. Tese (Doutorado em Estudo da Linguagem) - Universidade Federal do Rio Grande do Norte, Natal, 2007. Disponível em: https://repositorio.ufrn.br/handle/123456789/16265. Acesso em: 01 ago. 2022.
PIVAC, Luke. The Professional Technical Communicator. Module 1. The origins and development of technical communication. 2014. Disponível em: Luke Pivac: the origins and development of technical communication - YouTube. Acesso em: 13 jul. 2023.
ROCHA, Nuno Antônio da Silva. Documentação de Software: Integração de Ferramentas de Modelação e Processamento de Textos. Orientador: Ademar Aguiar. 2007/2208. 137 f. Dissertação (Mestrado Integrado em Engenharia Informática e Computação) - Faculdade de Engenharia da Universidade do Porto, 2007/2008. Disponível em: https://repositorioaberto.up.pt/bitstream/10216/59642/1/000129520.pdf.
Acesso em: 01 ago. 2022.
TRAVAGLIA, Neuza Gonçalves. Tradução retextualização: a tradução numa perspectiva textual. Uberlândia: Edufu, 2003.
VAN DIJK, Teun A. La ciência del texto. 3 ed. Barcelona: Paidós Ibérica, 1978. Disponível em: http://www.discursos.org/oldbooks/Teun%20ª%20van%20Dijk%20-%20La%20Ciencia%20del%20Texto.pdf. Acesso em: 11 ago. 2022.
Downloads
Published
How to Cite
Issue
Section
License
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.
