테크니컬 라이팅 - Word

Tags: technical writing

June 25, 2021

새로운 혹은 익숙하지 않은 용어를 정의하라

읽을 사람이 익숙하지 않거나 모를 수 있는 용어가 있다면:

  • 이미 용어가 존재하면 링크를 제공해라.
  • 당신의 문서가 용어를 처음 사용한다면 정의해라.
  • 한 문서에서 여러 용어를 정의한다면 문서 내에 따로 용어 리스트(glossary)를 만들어라.

용어를 바꿔가며 사용하지 마라

용어 하나를 정의했다면 그것만 사용해라. 만약 더 짧은 단어가 있다면 괄호를 사용해 미리 알려라.

두문자어(acronym)를 적절히 사용하라

두문자어가 정말 필요한가?:

  • 문서에서 많이 사용되는가?
  • 원래 단어보다 충분히 짧은가?

친숙하지 않은 두문자어를 문서에 사용한다면:

  • 처음에 원래 단어를 사용한 후 괄호안에 두문자어를 넣어라.
  • 원래 단어와 두문자어를 볼드체로 바꿔라.
  • 그 이후로는 두문자어만 사용하라.

대명사를 명확히 사용하라

  • 명사를 사용한 후에 대명사를 사용하라.
  • 가리키는 명사에서 가능하면 가까이에 놓아라.
  • 명사과 대명사 사이에 다른 단어가 들어간다면 대명사 대신 명사를 사용하라.

Reference