Princípios para concluir uma redação técnica com clareza

1. Em vez de usar um tom excessivamente formal, escreva em linguagem cotidiana.

2. Leia o texto em voz alta e verifique se “soa como algo que uma pessoa real diria”.

3. Tenha em mente os interesses do usuário, seu perfil, nível de formação e experiência, o tempo e o lugar em que ele lê o texto e seu ambiente de trabalho.

4. Selecione e forneça as informações que o usuário provavelmente vai querer saber e aquelas de que ele precisa.

5. Considere que nem todos os usuários conhecem o produto e as tecnologias relacionadas tão bem quanto um especialista.

6. Mesmo depois de publicar o texto, reflita em tempo hábil as mudanças em termos, modo de uso e funcionalidades.

7. Não use modificadores desnecessários, partículas gramaticais supérfluas nem auxiliares verbais equivalentes a “estar fazendo”.

8. Não use construções passivas duplas.
   Ex.) 잡혀지다 (→ 잡히다), 쓰여지다 (→ 쓰이다), 읽혀지다 (→ 읽히다), 보여지다 (→ 보이다), 잊혀지다 (→ 잊히다), 찢겨지다 (→ 찢기다)

9. Não acrescente um marcador de plural ao substantivo que vem depois de “vários/muitos/diversos/todos”.

10. Se for realmente necessário usar um termo técnico, explique esse termo no próprio texto.

11. Ao escrever para pessoas de um setor ou profissão específicos, use a terminologia desse setor ou profissão.

12. Depois de terminar o texto e descansar um pouco, leia-o novamente.

13. Se você escreveu o texto no desktop, leia-o no smartphone ou no tablet. Também pode imprimi-lo e ler no papel.

14. Leia o texto em voz alta e confira como ele soa.

15. Corrija frases que sejam difíceis de dizer ou que soem estranhas.

16. Pergunte ao revisor coisas como “o conteúdo do texto está fácil de entender?”, “o fluxo do texto está bom?” e “há algo a acrescentar?”. Também vale fazer perguntas específicas sobre os pontos em que você precisa de feedback.

17. Se um recurso específico foi abordado no texto, teste se “esse recurso funciona conforme descrito”.

18. Verifique se “os nomes de recursos e menus ou o conteúdo da tela correspondem ao que está no texto”.

19. Use um corretor ortográfico para verificar erros de digitação e de espaçamento.
    Ferramentas recomendadas: corretor ortográfico da Universidade Nacional de Busan, corretor ortográfico do Daum

20. Consulte os exemplos das regras oficiais de transliteração de palavras estrangeiras do Instituto Nacional da Língua Coreana e verifique erros de grafia em estrangeirismos.

[princox]

Os erros na grafia de estrangeirismos realmente causam bastante problema,,
method, angel e coisas do tipo muitas vezes acabam sendo escritas de formas que não seguem a transliteração correta.

O problema é que a "grafia incorreta" é a mais usada e ainda por cima tem até melhor SEO.. é uma situação sem cabimento.

Qual seria a forma certa..? ;_;

[roxie]

Acho que o problema é uma notação que não consegue refletir a realidade.

[ah2dius]

https://meetup.nhncloud.com/posts/355

Talvez não seja a resposta certa, mas vale a pena usar como referência~

[princox]

O correto é que cada um aparece como "método" e "Angel". Além disso, no caso de object, a Microsoft também vem simplificando para "objeto"...

Realmente, technical writing é muito difícil.

[pugh123]

Obrigado pelo ótimo conteúdo.