Os 10 mandamentos da redação técnica para desenvolvedores
(tech-kakaoenterprise.tistory.com)-
Não omitir os elementos essenciais da frase
-
Manter a concordância entre os elementos da frase
-
Usar corretamente as partículas gramaticais
-
Evitar a voz passiva e a forma causativa
-
Evitar a dupla negação
-
Usar expressões claras
-
Distinguir ordem e lista
-
Utilizar estilo em tópicos
-
Verificar ortografia e espaçamento
-
Verificar a grafia de palavras estrangeiras
2 comentários
Os 4 princípios do technical writing https://pt.news.hada.io/topic?id=5409
A arte da revisão - como desenvolvedores escrevem documentação técnica https://pt.news.hada.io/topic?id=5446
No caso dos programadores, na prática basta se preocupar apenas com o inglês quando se trata de romanização de estrangeirismos, mas vale lembrar que as regras coreanas para palavras estrangeiras se baseiam na pronúncia real, não na ortografia, e que o inglês não reflete bem a pronúncia na escrita, então você cometerá menos erros se transcrever com base nos símbolos fonéticos, e não na grafia da palavra.
Se não tiver certeza, 1) procure a palavra em inglês diretamente em um dicionário coreano e, se ela aparecer, use essa forma; 2) se não aparecer, procure a palavra em um dicionário de inglês e infira a grafia a partir do Alfabeto Fonético Internacional (IPA). No entanto, como as regras de transcrição de estrangeirismos para o inglês tomam a pronúncia britânica como referência, às vezes surgem grafias inesperadas.
Se não for inglês, é prático usar algo como o Hangulize (https://hangulize.org/), mas como a ortografia do inglês é uma bagunça, é difícil fazer isso de forma mecânica desse jeito, e dizem que um dicionário é indispensável. (No caso de neologismos, às vezes eles ainda não foram registrados em dicionários, então pode ser necessário verificar em lugares como o YouTube como as pessoas estão pronunciando aquela palavra.)